api doc's param & code-block display correctly #44
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
brentru
reviewed
Jul 20, 2020
brentru
reviewed
Jul 20, 2020
brentru
requested changes
Jul 20, 2020
There was a problem hiding this comment.
@2bndy5 Thanks for taking the time to do this, I have a few comments/changes to make before I can merge this in.
re: > Side-note: there are a lot more examples in this library that are not being displayed on RTD. Furthermore there are no module-level docstrings that would help identify the purpose of the examples (other than the example filename). I'm not too familiar with this library, so I didn't go crazy adding all the examples to examples.rst.
You're correct - we should add the purpose of these examples as docstrings to each of them. They've been increasing over time.
brentru
approved these changes
Jul 21, 2020
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Jul 22, 2020
Updating https://github.com/adafruit/Adafruit_CircuitPython_DS3231 to 2.4.0 from 2.3.2: > Merge pull request adafruit/Adafruit_CircuitPython_DS3231#27 from jepler/calibration-and-temperature Updating https://github.com/adafruit/Adafruit_CircuitPython_PCF8523 to 1.5.0 from 1.4.2: > Merge pull request adafruit/Adafruit_CircuitPython_PCF8523#19 from jepler/calibration-registers Updating https://github.com/adafruit/Adafruit_CircuitPython_PM25 to 1.0.2 from 1.0.1: > Merge pull request adafruit/Adafruit_CircuitPython_PM25#3 from dglaude/patch-1 Updating https://github.com/adafruit/Adafruit_CircuitPython_PyPortal to 3.3.0 from 3.2.5: > Merge pull request adafruit/Adafruit_CircuitPython_PyPortal#82 from fede2cr/master Updating https://github.com/adafruit/Adafruit_CircuitPython_MiniMQTT to 3.2.2 from 3.2.1: > Merge pull request adafruit/Adafruit_CircuitPython_MiniMQTT#44 from 2bndy5/master Updating https://github.com/adafruit/Adafruit_CircuitPython_ProgressBar to 1.3.0 from 1.2.3: > Merge pull request adafruit/Adafruit_CircuitPython_ProgressBar#8 from FoamyGuy/performance_boost Updating https://github.com/adafruit/Adafruit_CircuitPython_Requests to 1.5.0 from 1.4.3: > Merge pull request adafruit/Adafruit_CircuitPython_Requests#29 from brentru/update-cellular-3g
rtwfroody
pushed a commit
to rtwfroody/Adafruit_CircuitPython_MiniMQTT
that referenced
this pull request
Sep 18, 2022
api doc's param & code-block display correctly
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 went to read the docs for this library and noticed all the parameters and example code-blocks were not displaying properly because there was no empty line that preceded them. Verified locally via
sphinx-buildthat the changes generate properly.Upon further reading I noticed there was a (un-admonished) deprecation notice and a reference to an example that was not being displayed on RTD. I added the example to
examples.rstas "Basic Forever Loop", and I changed the notice to an admonished "Note" so that it sticks out to the reader better.Side-note: there are a lot more examples in this library that are not being displayed on RTD. Furthermore there are no module-level docstrings that would help identify the purpose of the examples (other than the example filename). I'm not too familiar with this library, so I didn't go crazy adding all the examples to
examples.rst.