Show info about resolution and mode in docs #11
Merged
Conversation
This file contains 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
TheKitty
approved these changes
Nov 6, 2024
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Nov 7, 2024
Updating https://github.com/adafruit/Adafruit_CircuitPython_AD569x to 2.0.4 from 2.0.3: > Merge pull request adafruit/Adafruit_CircuitPython_AD569x#4 from FoamyGuy/fix_circup_instruction Updating https://github.com/adafruit/Adafruit_CircuitPython_AHTx0 to 1.0.23 from 1.0.22: > Merge pull request adafruit/Adafruit_CircuitPython_AHTx0#22 from FoamyGuy/busy_timeout_calibration Updating https://github.com/adafruit/Adafruit_CircuitPython_AM2320 to 1.2.22 from 1.2.21: > Merge pull request adafruit/Adafruit_CircuitPython_AM2320#30 from FoamyGuy/wait_longer_after_wakeup Updating https://github.com/adafruit/Adafruit_CircuitPython_BH1750 to 1.1.12 from 1.1.11: > Merge pull request adafruit/Adafruit_CircuitPython_BH1750#11 from FoamyGuy/improve_docs Updating https://github.com/adafruit/Adafruit_CircuitPython_Bundle/circuitpython_library_list.md to NA from NA: > Updated download stats for the libraries
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.
in #9 the OP had trouble figuring out how to set the resolution setting on the sensor.
A quick look into the docs revealed that both
modeandresolutionwere undocumented, so I've added docstrings on the register fields and a bit more info into the enum class docs. I also removed the enum classes from the exclude list so that they will get included in the docs page.Here is a screenshot of how the docs look with a local build with these proposed changes:
