Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start basing mathtext tutorial on mathtext parser #26102

Merged
merged 1 commit into from
Jun 17, 2023

Conversation

oscargus
Copy link
Member

@oscargus oscargus commented Jun 10, 2023

PR summary

See #14766 (comment)

With this, the \*corner delimiters are no longer documented. Not sure if they should be included in the parsers list of delimiters or what we mean by delimiters here? Options are to include them manually in the docs or in a different section.

It would be easy to include relational operators and arrows as well, but the discrepancy between those are quite big....

Also adds a few misc symbols to the documentation and makes double and triple integral signs drop the subscript to get correct rendering. Adds quadruple integral symbol \iiiint and Unicode symbol for already supported \bigsqcup.

PR checklist

@oscargus oscargus force-pushed the mathtextdocgeneration branch 3 times, most recently from 3163ba8 to 5294112 Compare June 10, 2023 14:38
@oscargus oscargus marked this pull request as ready for review June 10, 2023 14:41
@oscargus
Copy link
Member Author

May I ask @devRD, @anntzer, and/or @jklymak to consider this? The idea is to, in the end, get consistency. If an operator is listed in a particular section (like relational operator), it will be documented as such. Currently, some are documented as relational operators, but not with the additional spacing required, some have the spacing but are not documented as supported. To only keep one list seems like a better idea. (Of course with the possibility to add more to the documentation in case some should not be spaced, although probably better to add them as an unused set in _mathtext.py).

It will probably take more than one PR to get there, but one will for sure find inconsistencies on the way. For example, the additional integral symbols were not dealt with correctly, although listed as supported.

@anntzer
Copy link
Contributor

anntzer commented Jun 16, 2023

Would it not be easier for math_symbol_table.py to just access the private lists in _mathtext.py (further splitting these lists if necessary) rather than maintaining two separate copies of the lists?

@oscargus
Copy link
Member Author

oscargus commented Jun 16, 2023 via email

@oscargus
Copy link
Member Author

To clarify my comment. That is exactly the idea. Where there is such a list in _mathtext it is used. (Except for the cases where the discrepancy currently is too large and I do not want to spend the time without seeing if it is a good idea to start with.)

@anntzer
Copy link
Contributor

anntzer commented Jun 17, 2023

Ah yes, sure, misread it.

@anntzer anntzer merged commit 9609937 into matplotlib:main Jun 17, 2023
@QuLogic QuLogic added this to the v3.8.0 milestone Jun 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants