You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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 and Check 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:
adafruit_icm20x.py:99
adafruit_icm20x.py:111
adafruit_icm20x.py:219
adafruit_icm20x.py:222
adafruit_icm20x.py:259
adafruit_icm20x.py:290
adafruit_icm20x.py:294
adafruit_icm20x.py:306
adafruit_icm20x.py:323
adafruit_icm20x.py:359
adafruit_icm20x.py:390
adafruit_icm20x.py:397
adafruit_icm20x.py:400
adafruit_icm20x.py:422
adafruit_icm20x.py:447
adafruit_icm20x.py:469
adafruit_icm20x.py:495
adafruit_icm20x.py:512
adafruit_icm20x.py:550
adafruit_icm20x.py:650
adafruit_icm20x.py:766
adafruit_icm20x.py:780
adafruit_icm20x.py:810
The text was updated successfully, but these errors were encountered:
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: