Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

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

Conversation

oscargus
Copy link
Member

PR summary

While preparing a presentation I saw some minor issues.

PR checklist

@oscargusoscargus added the Documentation: APIfiles in lib/ and doc/api labelAug 21, 2024

one_half : str, default: r"\frac{1}{2}"
one_half : str, default: r"\\frac{1}{2}"
Copy link
MemberAuthor

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
MemberAuthor

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

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

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

@oscargusoscargus added this to thev3.9-doc milestoneAug 21, 2024
Copy link
Member

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

@timhoffmtimhoffm merged commitf58632f intomatplotlib:mainAug 22, 2024
43 of 46 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestAug 22, 2024
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestAug 22, 2024
oscargus added a commit that referenced this pull requestAug 22, 2024
…743-on-v3.9.xBackport PR#28743 on branch v3.9.x (Minor fixes in ticker docs)
@QuLogicQuLogic modified the milestones:v3.9-doc,v3.9.3Aug 22, 2024
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Labels
Projects
None yet
Milestone
v3.9.3
Development

Successfully merging this pull request may close these issues.

3 participants
@oscargus@timhoffm@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp