Skip to content

Conversation

tekktrik
Copy link
Member

Resolves #38 by adding type annotations, and adding a few missing params from __init__() to the class docstring.

@tekktrik tekktrik requested a review from a team March 20, 2022 17:34
Copy link
Contributor

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

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

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

@FoamyGuy FoamyGuy merged commit 1eadd9f into adafruit:main Mar 21, 2022
@tekktrik
Copy link
Member Author

I think it would be fine if we included them in setup.py as required libraries on install, but it seemed like the intention was to make them optional, so I didn't introduce that as a change. It could be something to consider (for installs in Blinka environment).

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing Type Annotations

2 participants