Add type annotations, docstring params #42
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FoamyGuy
approved these changes
Mar 21, 2022
There was a problem hiding this comment.
These changes look good to me. I was thining maybe we wouldn't need to mock display_text and bitmap_font in the sphinx conf. But I attempted to build the docs a few different ways without them listed there and was unsuccessful.
I was either mistaken in thinking they wouldn't need mocked or else did not figure out the correct way to get them loaded for the docs to build.
I did get successful builds from the code as-is in this PR though.
Thanks @tekktrik
|
I think it would be fine if we included them in |
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Mar 22, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI to 4.1.0 from 4.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_ESP32SPI#159 from Neradoc/staticIP-hostname-and-dns Updating https://github.com/adafruit/Adafruit_CircuitPython_PCF8563 to 1.0.2 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_PCF8563#4 from tekktrik/doc/add-typing > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display to 3.10.12 from 3.10.11: > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#101 from makermelissa/master > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_Debouncer to 2.0.0 from 1.6.0: > Merge pull request adafruit/Adafruit_CircuitPython_Debouncer#38 from Neradoc/better-button-class Updating https://github.com/adafruit/Adafruit_CircuitPython_HTTPServer to 0.1.2 from 0.1.1: > Merge pull request adafruit/Adafruit_CircuitPython_HTTPServer#1 from askpatrickw/fix-install-commmand Updating https://github.com/adafruit/Adafruit_CircuitPython_MacroPad to 2.1.0 from 2.0.6: > Merge pull request adafruit/Adafruit_CircuitPython_MacroPad#39 from Neradoc/setup-layout-on-init Updating https://github.com/adafruit/Adafruit_CircuitPython_MagTag to 2.1.9 from 2.1.8: > Merge pull request adafruit/Adafruit_CircuitPython_MagTag#83 from UnicycleDumpTruck/add-type-annotations Updating https://github.com/adafruit/Adafruit_CircuitPython_Slideshow to 1.7.4 from 1.7.3: > Merge pull request adafruit/Adafruit_CircuitPython_Slideshow#42 from tekktrik/doc/add-typing > Fixed readthedocs build > Consolidate Documentation sections of README
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #38 by adding type annotations, and adding a few missing params from
__init__()to the class docstring.