FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Add overset/underset whatsnew entry by aitikgupta · Pull Request #19497 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

Add overset/underset whatsnew entry - #19497

Merged
anntzer merged 4 commits into
matplotlib:masterfrom
aitikgupta:overset-rst
Feb 11, 2021
ConversationCommits (4)ChecksFiles changed
Merged

Add overset/underset whatsnew entry#19497
anntzer merged 4 commits into
matplotlib:masterfrom
aitikgupta:overset-rst

Conversation

aitikgupta commented Feb 11, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor

PR Summary

This is a continuation of the previous PR #18916,
w.r.t. this comment: #18916 (comment)

PR Checklist

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

jklymak reviewed Feb 11, 2021
View reviewed changes
Comment thread doc/users/next_whats_new/mathtext.rst Outdated
Comment on lines +4 to +9
`.mathtext`, the default TeX layout engine which is shipped along with
Matplotlib now supports symbols like *overset* and *underset*.

The structure which should be followed: "\overset{body}{annotation}" or
"\underset{body}{annotation}", where *body* would be the text "above" or
"below" the *annotation* - the baseline character.

jklymak Feb 11, 2021

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality
Suggested change
`.mathtext`, the default TeX layout engine which is shipped along with
Matplotlib now supports symbols like *overset* and *underset*.
The structure which should be followed: "\overset{body}{annotation}" or
"\underset{body}{annotation}", where *body* would be the text "above" or
"below" the *annotation* - the baseline character.
`.mathtext` now supports *overset* and *underset*, called as
``\overset{body}{annotation}`` or ``\underset{body}{annotation}``, where
*annotation* is the text "above" or "below" the *body*.

jklymak reviewed Feb 11, 2021
View reviewed changes

jklymak left a comment

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Suggest more direct language. Also I think your transposed "body" and "annotation"

jklymak added this to the v3.4.0 milestone Feb 11, 2021

aitikgupta commented Feb 11, 2021

Copy link
Copy Markdown
Contributor Author

Suggest more direct language.

👍🏼

Also I think your transposed "body" and "annotation"

body is supposed to be the text that goes above or below the annotation, see #18916 (comment)
Also this:

matplotlib/lib/matplotlib/_mathtext.py

Lines 2875 to 2879 in 56d9e7c

if overunder == "under":
vlist = Vlist([cannotation, # annotation
Vbox(0, vgap), # space
cbody # body
])

anntzer commented Feb 11, 2021

Copy link
Copy Markdown
Contributor

I guess I didn't pay attention in my original review; certainly "body" should be the main thing and "annotation" the out-of-alignment extra thing.

jklymak commented Feb 11, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

Suggest more direct language.

👍🏼

Also I think your transposed "body" and "annotation"

body is supposed to be the text that goes above or below the annotation, see #18916 (comment)
Also this:

matplotlib/lib/matplotlib/_mathtext.py

Lines 2875 to 2879 in 56d9e7c

if overunder == "under":
vlist = Vlist([cannotation, # annotation
Vbox(0, vgap), # space
cbody # body
])

OK, that is super confusing. In \overset{\Delta x\to 0}{\longrightarrow} I'd have said \Delta x \to 0 is an annotation on \longrightarrow.

Ooops, crosspost with above.

aitikgupta commented Feb 11, 2021

Copy link
Copy Markdown
Contributor Author

I can clean the logic up in this PR
Initially even I was confused as to what annotation and body would be 😬

jklymak reviewed Feb 11, 2021
View reviewed changes
Comment thread doc/users/next_whats_new/mathtext.rst Outdated
---------------------------------------------------------------------------

`.mathtext` now supports *overset* and *underset*, called as
``\overset{body}{annotation}`` or ``\underset{body}{annotation}``, where

jklymak Feb 11, 2021

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

OK, but now this is wrong again, right?

aitikgupta Feb 11, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Yeah, I blindly copied the suggestion, let me fix that

anntzer merged commit 92b4bc3 into matplotlib:master Feb 11, 2021
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

anntzer anntzer approved these changes
jklymak jklymak approved these changes

Assignees

No one assigned

Labels

topic: text/mathtext

Projects

None yet

Milestone

v3.4.0

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL