Skip to content

Conversation

@isacben
Copy link

@isacben isacben commented Oct 3, 2022

Hi,

This PR solves the issue Add type annotations to docstrings #52

Please let me know if you have any comments!
Thanks!

Copy link
Member

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look good! Only request is to change the ones that can take None and make their types in the docstrings int|None. Using (Optional) makes it sounds like arguments don't have to be provided, which isn't really the Optional typing means.

@isacben
Copy link
Author

isacben commented Oct 4, 2022

Hi @tekktrik

Thanks for the feedback! Just completed the changes.

Copy link
Member

@tekktrik tekktrik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks!

@tekktrik tekktrik merged commit 656be4d into adafruit:main Oct 4, 2022
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Oct 5, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint to 2.2.10 from 2.2.9: > Merge pull request adafruit/Adafruit_CircuitPython_Fingerprint#49 from prcutler/issue32 Updating https://github.com/adafruit/Adafruit_CircuitPython_LTR329_LTR303 to 2.0.0 from 1.0.4: > Merge pull request adafruit/Adafruit_CircuitPython_LTR329_LTR303#3 from caternuson/iss2 Updating https://github.com/adafruit/Adafruit_CircuitPython_SI1145 to 1.1.5 from 1.1.4: > Merge pull request adafruit/Adafruit_CircuitPython_SI1145#15 from DeadSix27/patch-1 Updating https://github.com/adafruit/Adafruit_CircuitPython_TCA8418 to 1.0.5 from 1.0.4: > Merge pull request adafruit/Adafruit_CircuitPython_TCA8418#10 from prcutler/issue6 Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes to 2.5.6 from 2.5.5: > Merge pull request adafruit/Adafruit_CircuitPython_Display_Shapes#58 from isacben/add-type-annotations-to-docstrings Updating https://github.com/adafruit/Adafruit_CircuitPython_NTP to 3.0.8 from 3.0.7: > Merge pull request adafruit/Adafruit_CircuitPython_NTP#26 from prcutler/issue25 Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Added the following libraries: Adafruit_CircuitPython_BLE_File_Transfer
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants