Synchronize mathtext docs and handling #26173

oscargus · 2023-06-23T10:52:02Z

PR summary

Solves parts of #26174 (second commit).

This sort of guarantees that (at least in a while), there will be no discrepancy between which symbols are supported and that those are supported correctly. That is, if a symbol is listed as a relational operator, there will be spaces surrounding it.

Also adds a few new sections to the supported symbols list. Not sure if "Western Europe" is the best description for å, Å etc (although they are used in Swedish and some of the other are used in Norwegian etc.).

Listed directly supported script, fraktur and black board characters. If nothing else to see which works and which should maybe be added...

The ones that are not yet added are:

vec = ⃗
textasciicircum = ^
imageof = ⊷
origof = ⊶
solbar = ⌿
k = ̨
textexclamdown = ¡
llcorner = ⌞
invnot = ⌐
lq = ‘
greater = >
lrcorner = ⌟
not = ̸
bar = ̄
rightharpoonaccent = ⃑
textasciitilde = ~
leftharpoonaccent = ⃐
carriagereturn = ↵
overarc = ̑
candra = ̐
quad =  
minus = −
kernelcontraction = ∻
spadesuitopen = ♤
textquotedblleft = “
grave = ̀
acwopencirclearrow = ↺
dot = ̇
turnednot = ⌙
rasp = ʼ
H = ̋
ulcorner = ⌜
underbar = ̱
lasp = ʽ
c = ̧
colon = :
textasciiacute = ´
breve = ̆
textquestiondown = ¿
__sqrt__ = √
emdash = —
less = <
tilde = ̃
textasciigrave = `
smallsetminus = ∖
cdotp = ·
hat = ̂
acute = ́
d = ̣
t = ͡
dddot = ⃛
ocirc = ̊
ddddot = ⃜
thickspace =  
endash = –
urcorner = ⌝
prurel = ⊰
ddot = ̈
check = ̌
rq = ’
textquotedblright = ”
% = %
_ = _
# = #
guillemotleft = «
ring = ˚
guilsinglright = ›
macron = ¯
guillemotright = »
asterisk = *
guilsinglleft = ‹
plus = +
smallintclockwise = ∱
smallvarointclockwise = ∲
smallointctrcclockwise = ∳

The accents should probably be removed as they are handled separately. For example ddot is mapped to combiningdiaeresis.

Then, one may wonder if we want to openly state that we support \plus rather than simply using +?

PR checklist

"closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
Documentation complies with general and docstring guidelines

oscargus · 2023-06-23T10:58:41Z

Another change is that the extension prints the rendered symbols as above. Which clearly showed that leftbrace had the wrong mapping.

oscargus · 2023-06-23T11:34:56Z

The failing test is because mathtext adds space around the "spaced operators" in subscripts as well, while LaTeX doesn't. (\to was not in the list of arrows, but should be spaced in normal size.)

oscargus · 2023-06-23T12:17:40Z

Here is the outcome: https://output.circle-artifacts.com/output/job/0c35025a-735d-4800-a574-b790431306bd/artifacts/0/doc/build/html/users/explain/text/mathtext.html

A bit annoyingly *, +, and - are all interpreted as list bullets...

QuLogic · 2023-07-06T06:50:41Z

A bit annoyingly *, +, and - are all interpreted as list bullets...

Should maybe be fixed? Perhaps a backslash prefix will work?

QuLogic · 2023-07-06T07:18:25Z

doc/sphinxext/math_symbol_table.py

+     _mathtext.Parser._arrow_symbols],
+    ["Dot symbols",
+     4,
+     r"""\cdots \vdots \ldots \ddots \adots \Colon \therefore \because""".split()],


Aren't therefore and because in Relation operators?

Yes, they are. As well.

I just saw some table with "dot symbols" somewhere (do not remember where, maybe the "List of LaTeX symbols..." or whatever it is called), where they were included, so thought that it may make sense. Easy to modify though.

oscargus · 2023-07-07T02:02:20Z

Should maybe be fixed? Perhaps a backslash prefix will work?

Indeed. Just had no idea how to obtain it. Have tried to read up, but haven't found anything. I guess making an HTML table directly is a way to go though?

QuLogic · 2023-07-07T02:05:45Z

Usually, a backslash before characters will stop reST from treating them as whatever markup, so pretty sure that'll work for the bullets as well.

oscargus · 2023-07-13T05:16:23Z

Fixed. Seems to work.

oscargus · 2023-08-09T09:39:56Z

I think this should go in 3.8 since there are "half-made" changes towards this and this is the final step.

tacaswell · 2023-08-09T18:07:13Z

lib/matplotlib/_mathtext_data.py

@@ -910,7 +910,7 @@
    'O'                        : 216,
    'hookleftarrow'            : 8617,
    'trianglerighteq'          : 8885,
-    'nsime'                    : 8772,


Has this just been wrong from 2006 ?!

I guess so. However, I do not think it was documented so I wonder if someone ever used it?

tacaswell

I have some concern about the nsime -> nsimeq change, however it appears that nsimeq is the correct symbol.

https://milde.users.sourceforge.net/LUCR/Math/mathpackages/txfonts-symbols.pdf

If we need an API change note, we can add that in a follow up PR.

ksunden · 2023-08-09T18:44:35Z

lib/matplotlib/_mathtext_data.py

@@ -1066,7 +1068,7 @@
    'hermitmatrix'             : 8889,
    'barvee'                   : 8893,
    'measuredrightangle'       : 8894,
-    'varlrtriangle'            : 8895,


This looks to have been correct? lrtriangle is U+25ff (9727) and varlrtriangle is U+22bf (8895).

reference: https://ctan.mirrors.hoobly.com/fonts/stix/doc/stix.pdf

Both are triangles, but stix assigns this the same as the old name

ksunden · 2023-08-09T18:45:00Z

lib/matplotlib/_mathtext_data.py

@@ -1066,7 +1068,7 @@
    'hermitmatrix'             : 8889,
    'barvee'                   : 8893,
    'measuredrightangle'       : 8894,
-    'varlrtriangle'            : 8895,
+    'lrtriangle'               : 8895,


Suggested change

'lrtriangle' : 8895,

'varlrtriangle' : 8895,

I'll add lrtriangle then. DIdn't make sense to have varlrtriangle if we don't have lrtriangle...

I'm wondering if one should script the source of the STIX documentation and add all those symbols? The problem is just to add them to the documentation...

Reverted to varlrtriangle. Any additional symbols will be in another PR.

tacaswell · 2023-08-10T18:56:28Z

lib/matplotlib/_mathtext.py

@@ -1734,7 +1734,17 @@ class _MathStyle(enum.Enum):
      \cap            \triangleleft            \dagger
      \cup            \triangleright           \ddagger
      \uplus          \lhd                     \amalg
-      \dotplus        \dotminus'''.split())
+      \dotplus        \dotminus                \Cap


This is going to change how some things render, do we need a note about this?

changes addressed

ksunden · 2023-08-10T19:49:27Z

The doc build seems to still be getting lrtriangle instead of varlrtriangle

Seems to be due to

matplotlib/doc/sphinxext/math_symbol_table.py

Lines 79 to 80 in 655ec51

    
           if ignore_variant and sym != r"\varnothing": 
        
               sym = sym.replace(r"\var", "\\")

Probably the thing to do is to add just this one here.

oscargus · 2023-08-10T22:21:58Z

Ah, that may have been an additional reason for the name change...

oscargus · 2023-08-12T07:12:18Z

This is updated

…173-on-v3.8.x Backport PR #26173 on branch v3.8.x (Synchronize mathtext docs and handling)

oscargus added Documentation topic: text/mathtext labels Jun 23, 2023

oscargus mentioned this pull request Jun 23, 2023

[Bug]: Spaced symbols should not be spaced when in limits etc #26174

Open

oscargus mentioned this pull request Jun 23, 2023

Add more sizeable delimiters #26176

Merged

5 tasks

oscargus force-pushed the symboldocs branch from f492164 to a667d19 Compare June 23, 2023 15:21

github-actions bot added the status: needs rebase label Jun 24, 2023

oscargus force-pushed the symboldocs branch from a667d19 to cd8cfdc Compare June 24, 2023 13:05

github-actions bot removed the status: needs rebase label Jun 24, 2023

oscargus force-pushed the symboldocs branch 4 times, most recently from 7abdc11 to 8f656ba Compare June 24, 2023 15:42

oscargus added this to the v3.8.0 milestone Jun 26, 2023

This was referenced Jun 26, 2023

Sort tex2uni data in mathtext #26193

Merged

Dynamically calculating columns on Math symbols #26191

Closed

QuLogic reviewed Jul 6, 2023

View reviewed changes

oscargus force-pushed the symboldocs branch 2 times, most recently from d52726a to d7f95e6 Compare July 13, 2023 02:20

Synchronize mathtext docs and handling

fcf75dd

oscargus force-pushed the symboldocs branch from d7f95e6 to bdd8df3 Compare July 22, 2023 08:50

ksunden modified the milestones: v3.8.0, v3.8-doc Aug 8, 2023

oscargus removed this from the v3.8-doc milestone Aug 9, 2023

oscargus added this to the v3.8.0 milestone Aug 9, 2023

tacaswell reviewed Aug 9, 2023

View reviewed changes

tacaswell approved these changes Aug 9, 2023

View reviewed changes

ksunden previously requested changes Aug 9, 2023

View reviewed changes

ksunden reviewed Aug 9, 2023

View reviewed changes

oscargus force-pushed the symboldocs branch from bdd8df3 to b15872d Compare August 10, 2023 17:56

tacaswell reviewed Aug 10, 2023

View reviewed changes

oscargus force-pushed the symboldocs branch from b15872d to 655ec51 Compare August 10, 2023 19:13

Do not space symbols in limits

ee02182

oscargus force-pushed the symboldocs branch from 655ec51 to ee02182 Compare August 10, 2023 22:23

ksunden approved these changes Aug 14, 2023

View reviewed changes

ksunden merged commit ac95c22 into matplotlib:main Aug 14, 2023
38 of 39 checks passed

meeseeksmachine mentioned this pull request Aug 15, 2023

Backport PR #26173 on branch v3.8.x (Synchronize mathtext docs and handling) #26527

Merged

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Aug 15, 2023

Backport PR matplotlib#26173: Synchronize mathtext docs and handling

5d59820

ksunden added a commit that referenced this pull request Aug 15, 2023

Merge pull request #26527 from meeseeksmachine/auto-backport-of-pr-26…

7ecea2a

…173-on-v3.8.x Backport PR #26173 on branch v3.8.x (Synchronize mathtext docs and handling)

oscargus deleted the symboldocs branch August 16, 2023 08:59

ksunden mentioned this pull request Sep 15, 2023

merge up v3.8.0 #26785

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Synchronize mathtext docs and handling #26173

Synchronize mathtext docs and handling #26173

oscargus commented Jun 23, 2023 •

edited

oscargus commented Jun 23, 2023

oscargus commented Jun 23, 2023

oscargus commented Jun 23, 2023 •

edited

QuLogic commented Jul 6, 2023

QuLogic Jul 6, 2023

oscargus Jul 7, 2023

oscargus commented Jul 7, 2023

QuLogic commented Jul 7, 2023

oscargus commented Jul 13, 2023

oscargus commented Aug 9, 2023

tacaswell Aug 9, 2023

oscargus Aug 9, 2023

tacaswell left a comment

ksunden Aug 9, 2023

ksunden Aug 9, 2023

oscargus Aug 9, 2023

oscargus Aug 9, 2023

oscargus Aug 10, 2023

tacaswell Aug 10, 2023

ksunden commented Aug 10, 2023

oscargus commented Aug 10, 2023

oscargus commented Aug 12, 2023

Synchronize mathtext docs and handling #26173

Synchronize mathtext docs and handling #26173

Conversation

oscargus commented Jun 23, 2023 • edited

PR summary

PR checklist

oscargus commented Jun 23, 2023

oscargus commented Jun 23, 2023

oscargus commented Jun 23, 2023 • edited

QuLogic commented Jul 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

oscargus commented Jul 7, 2023

QuLogic commented Jul 7, 2023

oscargus commented Jul 13, 2023

oscargus commented Aug 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tacaswell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksunden commented Aug 10, 2023

oscargus commented Aug 10, 2023

oscargus commented Aug 12, 2023

oscargus commented Jun 23, 2023 •

edited

oscargus commented Jun 23, 2023 •

edited