Add type annotations, update documentation #29

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Merged

FoamyGuy merged 10 commits into adafruit:main from tekktrik:doc/typing-and-documentation

Jan 11, 2022

Member

tekktrik commented Jan 11, 2022

Addresses Issue Missing Type Annotations #27 by adding type annotations
Updates documentation in a few ways to make things more readable or provide more information

tekktrik and others added 10 commits

January 11, 2022 13:12


          Add typing and Sphinx documentation

d7e8d07


          Reformatted per pre-commit

e124c5c


          Added formatting library() docstring

ae01224


          Added params to Pause class docstring

1f2b89a


          Add links to Pause and Effect class reference in sequence() docstring

21f8bca


          Change docstring code to use code blocks

a3ce0e7


          Fix indentation in code blocks

3160f8b


          Added space after code block lines


          Merge branch 'main' into doc/typing-and-documentation

8c2960c


          Update example file to mention using all 8 slots

fde1577

FoamyGuy approved these changes

View reviewed changes

Contributor

FoamyGuy left a comment

Looks good to me. Thank you @tekktrik

FoamyGuy merged commit 17f16db into adafruit:main

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


          Automated update by Adabot (adafruit/adabot@e796bc0)

6a3fec1

Updating https://github.com/adafruit/Adafruit_CircuitPython_DRV2605 to 1.2.0 from 1.1.13:
  > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#29 from tekktrik/doc/typing-and-documentation
  > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#28 from tekktrik/feature/add-eight-slot
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_HTS221 to 1.1.7 from 1.1.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_HTS221#10 from tekktrik/feature/add-typing
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_PCA9685 to 3.4.0 from 3.3.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_PCA9685#42 from tekktrik/doc/add-typing
  > Merge pull request adafruit/Adafruit_CircuitPython_PCA9685#43 from tekktrik/feature/add-mode2-reg
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Wiznet5k to 1.12.0 from 1.11.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_Wiznet5k#49 from AdamCummick/main

Updating https://github.com/adafruit/Adafruit_CircuitPython_AVRprog to 1.4.2 from 1.4.1:
  > Merge pull request adafruit/Adafruit_CircuitPython_AVRprog#31 from aarontusko/fix-write_fuses-busy_wait

Updating https://github.com/adafruit/Adafruit_CircuitPython_OneWire to 1.2.8 from 1.2.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#24 from tekktrik/doc/add-typing
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_PIOASM to 0.5.4 from 0.5.3:
  > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#34 from dannystaple/mov_operators

Updating https://github.com/adafruit/Adafruit_CircuitPython_Requests to 1.10.5 from 1.10.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_Requests#94 from kevincon/fix-93

Updating https://github.com/adafruit/Adafruit_CircuitPython_Waveform to 1.3.9 from 1.3.8:
  > update rtd py version

tekktrik mentioned this pull request

Further documentation updates #30

Merged

# for free to join this conversation on GitHub. Already have an account? # to comment

Labels

None yet