sphinx doc improvements #24
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
Display the class' __init__ methods' docstrings in the online documentation. This helps users to understand the class APIs. Remove the docstring from the _XYZPacket parent class, because Sphinx was rendering that for every child class (AccelerometerPacket, GyroPacket, MagnetometerPacket, QuaternionPacket). Apparently the "autodoc_inherit_docstrings = False" setting does not work in that case.
As alluded in the __init__() docstring, explain that the "pressed" property is False when a button is released.
Some links went to the Adafruit_CircuitPython_ble project instead of this Adafruit_CircuitPython_BluefruitConnect project (possibly a bad copy-and-paste). Update those links to point to this project instead.
Remove the reference to the Feather nRF52840 Express, since this library can be used on many boards now (eg. Circuit Playground BlueFruit). Update BlueFruit Connect App link to point to Adafruit's main app web page, rather than the iOS-specific page, since this app is available for Andriod too now. Remove the GitHub releases link and add a link to to circuitpython.org's download page instead, because the GitHub release pages point there now.
Prior to this change, Sphinx incorrectly indented the "checksum" list item. Wrap and indent the lines at a proper length so that Sphinx renders this list item the same as the other items.
Explain that this attribute corresponds to whatever the user has pressed or released.
Link to Python's documentation for the "tuple" built-in type so readers can easily understand this term.
Explain that this comes from a user's choice in the application.
The QuaternionPacket's documentation was copy-pasted from the _XYZPacket class. Write a new docstring for the QuaternionPacket class to describe what it does.
|
Would you mind updating the issues PyLint flagged? I know they aren't from your PR but the build is failing with them. |
|
Sure. I'm going to push a separate PR for those. |
|
PyLint fix in #25 |
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Dec 29, 2020
Updating https://github.com/adafruit/Adafruit_CircuitPython_BNO08X to 1.0.3 from 1.0.2: > Merge pull request adafruit/Adafruit_CircuitPython_BNO08x#11 from TwoTenPvP/patch-2 > Merge pull request adafruit/Adafruit_CircuitPython_BNO08x#10 from TwoTenPvP/patch-1 Updating https://github.com/adafruit/Adafruit_CircuitPython_GPS to 3.6.6 from 3.6.5: > Merge pull request adafruit/Adafruit_CircuitPython_GPS#49 from d-c-d/master Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM9DS1 to 2.1.4 from 2.1.3: > Merge pull request adafruit/Adafruit_CircuitPython_LSM9DS1#27 from adafruit/spi_mag_auto_incr Updating https://github.com/adafruit/Adafruit_CircuitPython_SHTC3 to 1.0.4 from 1.0.3: > Merge pull request adafruit/Adafruit_CircuitPython_SHTC3#5 from mshannon78660/master Updating https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect to 1.1.5 from 1.1.4: > Merge pull request adafruit/Adafruit_CircuitPython_BluefruitConnect#24 from ktdreyer/docs-fixes > Merge pull request adafruit/Adafruit_CircuitPython_BluefruitConnect#25 from ktdreyer/button-packet-length Updating https://github.com/adafruit/Adafruit_CircuitPython_Slideshow to 1.5.3 from 1.5.2: > Merge pull request adafruit/Adafruit_CircuitPython_Slideshow#33 from ladyada/master > Merge pull request adafruit/Adafruit_CircuitPython_Slideshow#32 from adafruit/revert-30-join_paths_instead_of_concat
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.
I've updated the Sphinx documentation to fix some bad copy-and-pastes and make things clearer.