Add typing and other tweaks #11

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.

Sign up for GitHub

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

Jump to bottom

Merged

FoamyGuy merged 6 commits into adafruit:main from tekktrik:doc/add-typing

Jan 24, 2022

Member

tekktrik commented Jan 12, 2022

Adds type annotations like other libraries are getting
Changes a few instances of checking whether value is True OR False to isinstance() which is more Pythonic. Happy to revert if this was done for a specific reason
Updates Sphinx formatting in docstrings so things are clearer, or will display properly based on the hardships I've had with Sphinx haha. Can't confirm they help (or that anything was actually wrong yet) since documentation isn't viewable yet.

tekktrik added 6 commits

January 12, 2022 11:36


          Add type annotations

8ba1b6f


          Change to use isinstance()

df96549


          Fix code blocks and Sphinx params

de00d48


          Reformatted per pre-commit

1d3a83b


          Added space after write()

2edc0a6


          Reformatted per pre-commit

62aff88

Member Author

tekktrik commented Jan 12, 2022

Here is the equivalent PR for the FRAM library: adafruit/Adafruit_CircuitPython_FRAM#33

FoamyGuy approved these changes

View reviewed changes

Collaborator

FoamyGuy left a comment

LGTM. Thanks for the typing and docs improvements @tekktrik

Tested successfully with simpletest on Feather RP2040 7.2.0-alpha.1

FoamyGuy merged commit b710d97 into adafruit:main

adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request


          Automated update by Adabot (adafruit/adabot@e0933a7)

16dc73a

Updating https://github.com/adafruit/Adafruit_CircuitPython_24LC32 to 1.0.1 from 1.0.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_24LC32#11 from tekktrik/doc/add-typing
  > Merge pull request adafruit/Adafruit_CircuitPython_24LC32#12 from tekktrik/hotfix/patch-cleanup-fix

Updating https://github.com/adafruit/Adafruit_CircuitPython_ADS1x15 to 2.2.11 from 2.2.10:
  > First part of patch
  > Merge pull request adafruit/Adafruit_CircuitPython_ADS1x15#77 from nlantau/patch-1
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO055 to 5.3.3 from 5.3.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_BNO055#90 from adafruit/patch-fix
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_CCS811 to 1.3.6 from 1.3.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_CCS811#47 from sti320a/patch-1
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_CLUE to 3.0.2 from 3.0.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_CLUE#54 from kevinjwalters/sample-fix
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI to 4.0.0 from 3.6.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ESP32SPI#146 from tekktrik/fix/rename-pin-args
  > Merge pull request adafruit/Adafruit_CircuitPython_ESP32SPI#155 from tekktrik/hotfix/fix-recv-into
  > First part of patch

Updating https://github.com/adafruit/Adafruit_CircuitPython_SCD4X to 1.2.2 from 1.2.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_SCD4X#12 from KeithTheEE/get-data-ready-status-fix
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_STMPE610 to 1.3.0 from 1.2.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_STMPE610#22 from CedarGroveStudios/main
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Thermistor to 3.4.0 from 3.3.8:
  > Merge pull request adafruit/Adafruit_CircuitPython_Thermistor#19 from raquo/main
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font to 1.5.5 from 1.5.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_Bitmap_Font#56 from tekktrik/feature/ignore-comments-parsing
  > First part of patch

Updating https://github.com/adafruit/Adafruit_CircuitPython_Debouncer to 1.4.0 from 1.3.13:
  > Merge pull request adafruit/Adafruit_CircuitPython_Debouncer#34 from prplz/main
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Button to 1.6.2 from 1.6.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_Display_Button#34 from adafruit/patch-fix
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Logging to 3.7.4 from 3.7.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_Logging#25 from JingleheimerSE/add-time-format-specifier
  > First part of patch

Updating https://github.com/adafruit/Adafruit_CircuitPython_MacroPad to 2.0.4 from 2.0.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#34 from adafruit/patch-fix
  > First part of patch
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Simple_Text_Display to 1.2.2 from 1.2.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_Simple_Text_Display#10 from adafruit/patch-fix
  > First part of patch
  > update rtd py version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet