fix: minor documentation formatting issues #7469
Draft
+7
−7
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
gvwilson
added
P1
gvwilson
force-pushed
the
fix-doc-formatting
branch
from
503a303 to
a795c9f
Compare
9 tasks
…arkdown. - Put back-quotes around HTML tags in `src/components/annotations/attributes.js` so that they are not interpreted literally in Python Markdown documentation. - Fix mis-matched asterisk and back-quote in `src/components/errorbars/attributes.js`. - Format comparison operators and interval operators in `src/traces/contour/attributes.js` as back-quoted text so that angle brackets and square brackets don't confuse Markdown formatting in Python documentation.
gvwilson
force-pushed
the
fix-doc-formatting
branch
from
a795c9f to
c1649b4
Compare
|
Thanks @gvwilson. |
Correct wrong description of hovertemplate regarding the use of tag `<extra>`
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.
Minor documentation fixes needed for switch in plotly.py documentation framework. Paired with plotly/plotly.py#5276 (which generates Python documentation using
mkdocs).src/components/annotations/attributes.jsso that they are not interpreted literally in Python Markdown documentation.
src/components/errorbars/attributes.js.src/traces/contour/attributes.jsas back-quoted text so that angle brackets and square brackets don't confuse
Markdown formatting in Python documentation.
To do:
CONTRIBUTING.mdsayspython scripts/updatejs.py --dev --devrepo reponame --devbranch branchnamebutcommands.pydidn't appear to support--devrepoor--devbranch.CONTRIBUTING.mdalso mentions--localwhichcommands.pyalso didn't provide.