Docs: formatting issue for Sparkline.add_value #51
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
Add missing blank line in the docstring of Sparkline.add_value
tekktrik
approved these changes
Jul 12, 2022
|
Thanks @tekktrik for the quick review! It did fix the rendering (same link as above): |
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Jul 13, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1306 to 2.12.7 from 2.12.6: > Merge pull request adafruit/Adafruit_CircuitPython_SSD1306#74 from tekktrik/dev/add-optional-requirements Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Shapes to 2.5.1 from 2.5.0: > Merge pull request adafruit/Adafruit_CircuitPython_Display_Shapes#51 from nicolasff/patch-1 Updating https://github.com/adafruit/Adafruit_CircuitPython_Logging to 4.1.3 from 4.1.2: > Merge pull request adafruit/Adafruit_CircuitPython_Logging#36 from FoamyGuy/docs_attributes_fix
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.
Hello,
The documentation for the
add_valuemethod of theSparklineclass has some rendering issues, with the parameters not being listed correctly. The text:param value:and:param update:is visible on the page, instead of having the effect of listing each parameter individually.Here's how it gets rendered (from this page):
I believe this is due to the lack of a new line between the description for the method and the list of parameters. This commits adds the missing line.
See for comparison how this looks for the constructor, there's a gap before
:param width:Adafruit_CircuitPython_Display_Shapes/adafruit_display_shapes/sparkline.py
Lines 50 to 55 in cdef091