-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Minor fixes in ticker docs #28743
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Minor fixes in ticker docs #28743
Conversation
|
||
one_half : str, default: r"\frac{1}{2}" | ||
one_half : str, default: r"\\frac{1}{2}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The backslash was missing from the rendered version, so will have to check it this gets it back...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to render correctly. (One may question if the r should be there, but if it is one can copy-and-paste it...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe make the whole docstring raw. Then you don't need backslash doubling here (but can keep the r prefix for copying).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is raw, which is why I had to test to see what happened. I do not really understand why I need to escape it, but that seems to do the trick...
matplotlib/lib/matplotlib/ticker.py
Lines 1145 to 1153 in a254b68
r""" | |
Parameters | |
---------- | |
use_overline : bool, default: False | |
If x > 1/2, with x = 1-v, indicate if x should be displayed as | |
$\overline{v}$. The default is to display $1-v$. | |
one_half : str, default: r"\frac{1}{2}" | |
The string used to represent 1/2. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I'm confused. This feels like a bug in sphinx. But I question that it's worth tracking down.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, not obvious why it is required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's just not bother.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Take or leave my comment.
…743-on-v3.9.x Backport PR #28743 on branch v3.9.x (Minor fixes in ticker docs)
PR summary
While preparing a presentation I saw some minor issues.
PR checklist