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

DOC: clarify usetex versus mathtext#27017

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

Conversation

jklymak
Copy link
Member

Closes#26968 (probably) by explaining difference between mathtext and usetex.

PR summary

PR checklist

@story645story645 added the Documentation: user guidefiles in galleries/users_explain or doc/users labelOct 6, 2023
@@ -327,6 +327,9 @@ This allows users to set the location of the legend in a more flexible and consi
Mathtext improvements
=====================

Mathtext is Matplotlib's native TeX-like mathematics parser (:ref:`mathtext`),
Copy link
Member

@timhoffmtimhoffmOct 6, 2023
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I'm unclear what the statement should communicate. Is it intended as a general description to give context what mathtext is? That'd be a bit odd. We don't have such descriptions for other what's new sections.
Or does it document the improvement in this PR? In that case I suggest

Suggested change
Mathtext is Matplotlib's native TeX-like mathematics parser (:ref:`mathtext`),
Clarify thatMathtext is Matplotlib's native TeX-like mathematics parser (:ref:`mathtext`),

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think here@jklymak is specifically adding the context. In the issue it's supposed to be closing#26968, the issue poster was trying to use a mathtext feature while also setting usetex as true.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Granted, we could also be probably be more direct "These features are additions to :ref:Mathtext <mathtext> and may not work if :ref:usetex<usetex is set to True" since this is a what's new.

timhoffm reacted with thumbs up emoji
Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

"mathtext" is jargon, so it would be nice to define it, at least by a link. None of the code provided helps with the context either, since it could easily apply to usetex labels.

Copy link
Member

@timhoffmtimhoffmOct 7, 2023
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Ah, I see, this is an intro paragraph to a set of changes. While we typically don’t have that, I acknowledge your point on giving context. I’m +/-0 on this. Fundamentally, we can’t explain every concept of the library again in the changelog (e.g. we also don’t explain what a formatter is even though not all users will be familiar with that concept).
I’d be in favor of only linking, but not explaining. - Possibly even just link the “mathtext” word in the individual improvement messages.

But I withdraw from the discussion now. I’ve added my view and leave it up to you to decide this topic.

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I don't believe just putting a link in would have helped the OP (why would you click a link for something you think you understand) and folks are often confused by the difference between usetex and mathtext; there is a whole community thatalways have usetex=True, and probably forget that Matplotlib has mathtext handling. I don't think it hurts to explicitly remind them here.

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I changed this sentence to be:

Improvements are to Mathtext, Matplotlib's native TeX-like mathematics parser(see :ref:`mathtext`, not to be confused with Matplotlib using LaTeX directly::ref:`usetex`).

timhoffm reacted with thumbs up emoji
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

It seems you haven’t pushed yet.

Copy link
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

ooops....

@jklymakjklymakforce-pushed thedoc-clarify-usetex-mathtext branch fromc4f6c6a to7d89a38CompareOctober 8, 2023 14:49
@timhoffmtimhoffm added this to thev3.8.1 milestoneOct 8, 2023
@timhoffmtimhoffm merged commitd17bfe8 intomatplotlib:mainOct 8, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestOct 8, 2023
rcomer added a commit that referenced this pull requestOct 8, 2023
…017-on-v3.8.xBackport PR#27017 on branch v3.8.x (DOC: clarify usetex versus mathtext)
@ksundenksunden mentioned this pull requestNov 2, 2023
5 tasks
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@story645story645story645 approved these changes

@timhoffmtimhoffmtimhoffm approved these changes

@oscargusoscargusAwaiting requested review from oscargus

Assignees
No one assigned
Labels
Documentation: user guidefiles in galleries/users_explain or doc/usersDocumentation
Projects
None yet
Milestone
v3.8.1
Development

Successfully merging this pull request may close these issues.

[Bug]: matplotlib 3.8: new mathtext feature "\text" fails.
3 participants
@jklymak@story645@timhoffm

[8]ページ先頭

©2009-2025 Movatter.jp