Skip to content

Minor fixes in ticker docs#28743

Merged
timhoffm merged 1 commit intomatplotlib:mainfrom
oscargus:tickerdocs
Aug 22, 2024
Merged

Minor fixes in ticker docs#28743
timhoffm merged 1 commit intomatplotlib:mainfrom
oscargus:tickerdocs

Conversation

@oscargus
Copy link
Copy Markdown
Member

PR summary

While preparing a presentation I saw some minor issues.

PR checklist

@oscargus oscargus added the Documentation: API files in lib/ and doc/api label Aug 21, 2024
$\overline{v}$. The default is to display $1 - v$.

one_half : str, default: r"\frac{1}{2}"
one_half : str, default: r"\\frac{1}{2}"
Copy link
Copy Markdown
Member Author

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...

Copy link
Copy Markdown
Member Author

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...

Copy link
Copy Markdown
Member

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).

Copy link
Copy Markdown
Member Author

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...

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.

Copy link
Copy Markdown
Member

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.

Copy link
Copy Markdown
Member Author

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.

Copy link
Copy Markdown
Member

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.

@oscargus oscargus added this to the v3.9-doc milestone Aug 21, 2024
Copy link
Copy Markdown
Member

@timhoffm timhoffm left a 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.

@timhoffm timhoffm merged commit f58632f into matplotlib:main Aug 22, 2024
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 22, 2024
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 22, 2024
oscargus added a commit that referenced this pull request Aug 22, 2024
…743-on-v3.9.x

Backport PR #28743 on branch v3.9.x (Minor fixes in ticker docs)
@QuLogic QuLogic modified the milestones: v3.9-doc, v3.9.3 Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants