Skip to content

Support \text in mathtext #22173

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

Merged
merged 1 commit into from
Mar 31, 2023
Merged

Conversation

oscargus
Copy link
Member

@oscargus oscargus commented Jan 9, 2022

PR Summary

Closes #18520

import matplotlib.pyplot as plt
plt.text(0.1, 0.5, r"where $a = \sin(\phi) \text{ such that } \phi = \frac{x}{y}$")
plt.draw()

gives
image

However, the kerning is still from math, see

import matplotlib.pyplot as plt
plt.text(0.1, 0.5, r"where $a = \sin(\phi) \text{ where } \phi = \frac{x}{y}$")
plt.draw()

image
where the spacing between the e and the r in where differs.

However, it is not the case for e.g. r"where $\text{where}$" so not really clear to me why and where this happens.

image

Again, a bit doubtful (see #22171) if I can generate correct test images, so tests must be added.

It is not really clear how things will work with special symbols etc. Right now \{, \} and \$ can be dealt with, but one can probably break it if one tries (as for LaTeX itself).

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@oscargus
Copy link
Member Author

oscargus commented Jan 9, 2022

And as I was a bit doubtful myself, it works with sub- and superscripts as well:
image

@QuLogic QuLogic changed the title mathtext now supports \text Support \text in mathtext Jan 11, 2022
@oscargus oscargus mentioned this pull request Jan 12, 2022
6 tasks
@@ -2294,6 +2301,18 @@ def non_math(self, s, loc, toks):
self.get_state().font = mpl.rcParams['mathtext.default']
return [hlist]

def text(self, s, loc, toks):
self.pop_state()
Copy link
Contributor

Choose a reason for hiding this comment

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

This won't work with something like r"$\mathbf{\text{hello, world!}}$" (popping out of the mathbf puts you in italic mode, and setting back to italic at exit isn't correct either; instead I think you just need to push a new state for the \text.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ahh, OK! I'll look into the state things. Almost looked a bit too easy to solve it...

@anntzer
Copy link
Contributor

anntzer commented Jan 13, 2022

I can't repro the kerning issue? Usually you can try blowing up text size (e.g. fontsize=42) to make it easier to check them; otherwise it may just be pixellation.

One major comment, but otherwise the approach looks good to me. (Just needs a test as well.)

@oscargus
Copy link
Member Author

This is updated (although I only pushed, not commented), if you have time @anntzer ...

@anntzer
Copy link
Contributor

anntzer commented Mar 28, 2023

Just one minor point left, I think.
Also, is the kerning issue you mentioned originally fixed?

@greglucas greglucas merged commit 83afb15 into matplotlib:main Mar 31, 2023
@oscargus oscargus deleted the textinmathtext branch April 1, 2023 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants