Skip to content

Added type annotations to docstrings #58

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
merged 2 commits into from
Oct 4, 2022
Merged

Added type annotations to docstrings #58

merged 2 commits into from
Oct 4, 2022

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!

This was linked to issues Oct 4, 2022
Add type annotations to docstrings #52
Closed
CircuitPython v8.0.0-beta.2: display_shapes.polygon color fill is rendering very slowly #57
Closed
tekktrik
tekktrik requested changes Oct 4, 2022
View reviewed 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.

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.

@tekktrik tekktrik removed a link to an issue Oct 4, 2022
CircuitPython v8.0.0-beta.2: display_shapes.polygon color fill is rendering very slowly #57
Closed
@isacben
Copy link
Author

isacben commented Oct 4, 2022

Hi @tekktrik

Thanks for the feedback! Just completed the changes.

tekktrik
tekktrik approved these changes Oct 4, 2022
View reviewed 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
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@eaa233b)
e290146 
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
Reviewers

@tekktrik tekktrik tekktrik approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add type annotations to docstrings
2 participants
@isacben @tekktrik