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

Add overset/underset whatsnew entry

9649d83

jklymak reviewed

Feb 11, 2021

View reviewed changes

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.

Copy link

Member

jklymakFeb 11, 2021

Choose a reason for hiding this comment

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

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

Copy link

Member

jklymak left a comment

Choose a reason for hiding this comment

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

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

jklymak added the Documentation label

Feb 11, 2021

jklymak added this to thev3.4.0 milestone

Feb 11, 2021

Copy link

ContributorAuthor

aitikgupta commentedFeb 11, 2021

Suggest more direct language.

👍🏼

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

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

matplotlib/lib/matplotlib/_mathtext.py

Lines 2875 to 2879 in56d9e7c

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

Copy link

Contributor

anntzer commentedFeb 11, 2021

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.

Copy link

Member

jklymak commentedFeb 11, 2021•
edited
Loading

Suggest more direct language.
👍🏼
Also I think your transposed "body" and "annotation"
body is supposed to be the text that goes above or below theannotation, see#18916 (comment)
Also this:
matplotlib/lib/matplotlib/_mathtext.py
Lines 2875 to 2879 in56d9e7c
ifoverunder=="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.

Copy link

ContributorAuthor

aitikgupta commentedFeb 11, 2021

I can clean the logic up in this PR
Initially even I was confused as to whatannotation andbody would be 😬

aitikgupta added2 commits

February 11, 2021 22:02

Exchange variable names

2913f08

Simplify whatsnew entry

d891481

jklymak reviewed

Feb 11, 2021

View reviewed changes

doc/users/next_whats_new/mathtext.rst Outdated

		---------------------------------------------------------------------------

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

Copy link

Member