Skip to content

Add typing, small documentation and implementation corrections #19

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.

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

Merged
merged 5 commits into from
Dec 15, 2021
Merged

Add typing, small documentation and implementation corrections #19

merged 5 commits into from
Dec 15, 2021

Conversation

tekktrik
Copy link
Member

@tekktrik tekktrik commented Dec 14, 2021

  1. Added type hints
  2. adafruit_boardtest\boardtest_sd.py was not using a filename as a parameter in run_test() as the docstring implied. It looked like that was the intention so I now have it take a filename parameter that defaults to FILENAME
  3. baudrate was not documented in the method docstring for run_test() in adafruit_boardtest\boardtest_uart.py so I added the Sphinx param to it.
  4. Also had to locally disable a couple pylint warnings in adafruit_boardtest\boardtest_sd.py because it seems like run_test() is written as intended and readable, so the warnings should just be surpressed (too many arguments, too many local variables)

@tekktrik
Copy link
Member Author

This also addresses Issue #17

@tekktrik
Copy link
Member Author

Created issues for the various non-typing items as needed in order to track them (Issues #20 and #21)

Copy link
Member

@tannewt tannewt left a comment

Choose a reason for hiding this comment

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

Thank you!

@tannewt tannewt merged commit 828faa2 into adafruit:main Dec 15, 2021
@tekktrik tekktrik mentioned this pull request Dec 15, 2021
18 tasks
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Dec 28, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 4.1.8 from 4.1.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#80 from Daviey/moar_lolz
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_RA8875 to 3.1.8 from 3.1.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_RA8875#28 from adafruit/dhalbert-ustruct
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_SI5351 to 1.2.10 from 1.2.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_SI5351#24 from adafruit/dhalbert-ustruct
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet to 0.11.0 from 0.10.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_BLE_BroadcastNet#23 from tekktrik/feature/add-sound-level
  > Merge pull request adafruit/Adafruit_CircuitPython_BLE_BroadcastNet#22 from tekktrik/feature/add-typing
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect to 1.2.0 from 1.1.10:
  > Merge pull request adafruit/Adafruit_CircuitPython_BluefruitConnect#33 from TonyLHansen/main
  > update rtd py version

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

Updating https://github.com/adafruit/Adafruit_CircuitPython_CursorControl to 2.5.1 from 2.5.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_CursorControl#30 from tekktrik/feature/add-typing
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_hashlib to 1.4.0 from 1.3.6:
  > Update README.rst
  > Merge pull request adafruit/Adafruit_CircuitPython_hashlib#17 from timhawes/main
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Motor to 3.3.3 from 3.3.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_Motor#59 from FoamyGuy/typing_input_error_catch

Updating https://github.com/adafruit/Adafruit_CircuitPython_Register to 1.9.7 from 1.9.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_Register#46 from adafruit/dhalbert-ustruct
  > update rtd py version

Updating https://github.com/adafruit/Adafruit_CircuitPython_Requests to 1.10.3 from 1.10.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_Requests#87 from tekktrik/main
  > 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants