-
Notifications
You must be signed in to change notification settings - Fork 21
Missing Type Annotations #56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Labels
Comments
intending to finish this at Pycon 2022 sprints |
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 2, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 2, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
finish adafruit#56, rename types
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
finish adafruit#56, rename types
PR opened, ready for review |
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
May 3, 2022
… add copyright year
FoamyGuy
added a commit
that referenced
this issue
May 9, 2022
Add types for #56 Missing type annotations
matt-land
added a commit
to matt-land/Adafruit_CircuitPython_ImageLoad
that referenced
this issue
Apr 24, 2023
2023 continue finish adafruit#56, rename types
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are missing type annotations for some functions in this library.
The
typing
module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:
If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github
There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages:
Sharing docs on ReadTheDocs
andCheck your code with pre-commit
contain the tools to install and commands to run locally to run the checks.If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the
#circuitpython-dev
channel.The following locations are reported by mypy to be missing type annotations:
The text was updated successfully, but these errors were encountered: