Add \underline to mathtext #15624

wesbarnett · 2019-11-07T17:02:51Z

PR Summary

Implements #14235 to add \underline to mathtext.

PR Checklist

Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

pprasha · 2020-03-22T01:20:05Z

let me take a look

Make type lists fit in a single line. A strict reading suggests that all types should be separated with ` or ` rather than a comma, but avoiding a backslash continuation seems more useful. Also, *s* can also be a str.

Fix validate_markevery docstring markup.

This was introduced in 2015 when support for running nose tests via `setup.py test` was removed. We do not need to explicitly tell people anymore that this is not possible.

Remove dummy test command from setup.py

…style

They are instead replaced by slightly roundabout ways to get hold of the same objects (CompilerError, CCompiler). Only distutils.sysconfig remains; we should investigate whether the stdlib's sysconfig is a satisfactory replacement for it.

As noted in the module docstring, there is a confusion between using a generic default MarkerStyle (empty) and the artist-specific one (e.g. scatter plots use `rcParams["scatter.marker"]`). Fortunately, direct construction of MarkerStyles (especially of empty ones) is hardly ever needed, so we can just make the parameter required.

…plate Fix typo in template of current dev-docs

Co-authored-by: Tim Hoffmann <[email protected]>

Co-authored-by: David Stansby <[email protected]>

Deprecate support for no-args MarkerStyle().

[Doc] colors.to_hex input & output

As for other APIs, this is less likely to be confused with the None object.

Add CPython 3.10 wheels

Unlike the Agg renderer, the Cairo renderer exists forever and is at the DPI when the figure was created. This needs to be updated before drawing or things in physical sizes (e.g., text or line widths) will be the wrong size.

Otherwise, `FigureCanvasBase.get_width_height` returns a size scaled down by the current pixel ratio, even though the DPI is not scaled up. This causes the saved figure to be cropped.

Remove generated file accidentally added in matplotlib#20867

set_dashes does not support offset=None anymore.

Simplify setting Legend attributes

wesbarnett · 2021-10-07T12:41:53Z

@QuLogic you can remove the "work in progress" tag for this. It's ready to be reviewed. Thanks!

jklymak · 2021-10-12T12:28:26Z

lib/matplotlib/_mathtext.py

@@ -2915,6 +2922,26 @@ def overline(self, s, loc, toks):
        hlist = Hlist([rightside])
        return [hlist]

+    def underline(self, s, loc, toks):
+        (body,), = toks


Thanks for your perseverance with this. Is it possible the test coverage could hit these missing lines?

jklymak · 2021-11-08T09:27:13Z

@wesbarnett popping to draft until the rebase gets figured out.... You may need to follow instructions at https://discourse.matplotlib.org/t/default-branch-renamed-with-minor-edit-to-history/22367/2 Thanks!

tfpf · 2022-08-12T16:17:47Z

There haven't been any updates here for a while. Unless I am mistaken, this is not extremely hard to implement. The details are in node 735 of TeX, but it doesn't look that's what's happening here?

tfpf · 2022-08-14T09:01:56Z

I think mimicking TeX's behaviour is straightforward. Not sure how exactly overline works, but TeX puts a space between the text and the underline equal to thrice the thickness of the underline (even if the text has depth). Just adding vertical kerning should work?

I can open another pull request to implement it if that's okay.

timhoffm · 2022-08-14T09:51:53Z

I think mimicking TeX's behaviour is straightforward. Not sure how exactly overline works, but TeX puts a space between the text and the underline equal to thrice the thickness of the underline (even if the text has depth). Just adding vertical kerning should work?

I can open another pull request to implement it if that's okay.

I'm not a TeX expert, but if you have a straight-forward solution, please go ahead and open a new PR.

github-actions · 2023-06-30T02:05:35Z

Since this Pull Request has not been updated in 60 days, it has been marked "inactive." This does not mean that it will be closed, though it may be moved to a "Draft" state. This helps maintainers prioritize their reviewing efforts. You can pick the PR back up anytime - please ping us if you need a review or guidance to move the PR forward! If you do not plan on continuing the work, please let us know so that we can either find someone to take the PR over, or close it.

melissawm · 2023-07-04T15:57:44Z

It looks like there are two PRs trying to solve the same issue here - this one and #23616. Any chance @wesbarnett and @tfpf could team up or review each other's work so this feature can move forward? Thanks!

rcomer · 2023-07-04T16:44:28Z

Looks like @tfpf opened the other PR because this one had stalled....

tfpf · 2023-07-04T20:37:00Z

Initially, I though this approach could be improved by applying the make_under procedure of TeX (node 735 in TeX: the Program). To my utter surprise, wesbarnett's code (from here) and the TeX code (from #23616) produce the exact same images! Unless I have terribly messed something up, the PNG files are identical, byte for byte; the SVG files are also identical, at least visually.

import matplotlib.pyplot as plt
fig = plt.figure()
plt.text(.5, .5, r'$\underline{ul}$', size=50)
plt.axhline(.5)
plt.savefig('s.svg')
plt.savefig('p.png')
plt.show()

Note that the SVG and PNG backends render the image differently. I got stuck here, and documented it in #23763. Still unable to figure out why that happens.

wesbarnett · 2023-07-05T00:01:02Z

My PR is so far off with main at this point, I'm happy to close this as a duplicate of #23616. (My implementation was basically copying the overline functionality and making a few adjustments for it to be used as an underline.

QuLogic added status: work in progress topic: text/mathtext labels Nov 7, 2019

story645 added the mentored: hackathon label Nov 12, 2019

jklymak marked this pull request as draft July 23, 2020 03:22

anntzer and others added 25 commits September 12, 2021 14:02

Fix validate_markevery docstring markup.

f96a463

Make type lists fit in a single line. A strict reading suggests that all types should be separated with ` or ` rather than a comma, but avoiding a backslash continuation seems more useful. Also, *s* can also be a str.

Merge pull request matplotlib#21053 from anntzer/vme

47602ee

Fix validate_markevery docstring markup.

Remove dummy test command from setup.py

2d2fcb4

This was introduced in 2015 when support for running nose tests via `setup.py test` was removed. We do not need to explicitly tell people anymore that this is not possible.

Merge pull request matplotlib#21059 from timhoffm/cleanup-setup_py

23f1da4

Remove dummy test command from setup.py

Correct the default for fillstyle parameter in MarkerStyle()

f630a73

Merge pull request matplotlib#21060 from timhoffm/marker-default-fill…

f13147a

…style

Fix typo in template of current dev-docs

72c9c00

Remove most visible dependencies on distutils.

b8aa5b2

They are instead replaced by slightly roundabout ways to get hold of the same objects (CompilerError, CCompiler). Only distutils.sysconfig remains; we should investigate whether the stdlib's sysconfig is a satisfactory replacement for it.

Merge pull request matplotlib#21062 from deep-jkl/typo-in-new-doc-tem…

d27fba3

…plate Fix typo in template of current dev-docs

Update lib/mpl_toolkits/mplot3d/axes3d.py

cc2af22

Co-authored-by: Tim Hoffmann <[email protected]>

Update lib/matplotlib/colors.py

143c30e

Co-authored-by: David Stansby <[email protected]>

Merge pull request matplotlib#21056 from anntzer/msn

2e34f38

Deprecate support for no-args MarkerStyle().

Merge pull request matplotlib#20913 from story645/story645-to_hex

20170d7

[Doc] colors.to_hex input & output

Support marker="none" to mean "no marker".

4cef945

As for other APIs, this is less likely to be confused with the None object.

Docstring updated for scatter method

51438b2

Merge pull request matplotlib#20819 from hrnciar/wheels-py3.10

38bfebc

Add CPython 3.10 wheels

Remove generated file accidentally added in matplotlib#20867

55b0d93

Use correct DPI when drawing in Cairo renderers

0c021c7

Unlike the Agg renderer, the Cairo renderer exists forever and is at the DPI when the figure was created. This needs to be updated before drawing or things in physical sizes (e.g., text or line widths) will be the wrong size.

Added decorators to more methods in axes3d.py

ed53303

Set device pixel ratio when saving a figure

630f25f

Otherwise, `FigureCanvasBase.get_width_height` returns a size scaled down by the current pixel ratio, even though the DPI is not scaled up. This causes the saved figure to be cropped.

De-duplicate some unit conversion in Cairo

9598205

Merge pull request matplotlib#21067 from QuLogic/delete-extra

592319e

Remove generated file accidentally added in matplotlib#20867

Merge pull request matplotlib#21051 from anntzer/gdbdashes

1a0ebbb

set_dashes does not support offset=None anymore.

Merge pull request matplotlib#21049 from timhoffm/simplify-legend-attrs

fd3f25e

Simplify setting Legend attributes

anntzer removed the status: work in progress label Oct 7, 2021

wesbarnett mentioned this pull request Oct 7, 2021

Add \underline to mathtext? #14235

Open

jklymak reviewed Oct 12, 2021

View reviewed changes

tacaswell force-pushed the main branch from f6e0ee4 to a1eef38 Compare October 20, 2021 19:55

jklymak added status: needs rebase status: needs tests labels Nov 8, 2021

jklymak marked this pull request as draft November 8, 2021 09:26

tfpf mentioned this pull request Aug 14, 2022

Support \underline in Mathtext. #23616

Draft

5 tasks

github-actions bot added the status: inactive Marked by the “Stale” Github Action label Jun 30, 2023

wesbarnett force-pushed the underline branch from 6fdb617 to 17c99d9 Compare July 4, 2023 23:45

wesbarnett added 8 commits July 4, 2023 19:46

add back code to new location

0d36969

update documentation

87c0730

add tests

f6889cc

correct doc

5e23dc2

add whatsnew entry

ba67ed7

rm erroneous line

d7f6ad5

MathJax -> mathtext

827e09a

fix underline being too short

38e4a55

wesbarnett force-pushed the underline branch from 17c99d9 to 38e4a55 Compare July 4, 2023 23:46

wesbarnett closed this Jul 5, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add \underline to mathtext #15624

Add \underline to mathtext #15624

Uh oh!

wesbarnett commented Nov 7, 2019 •

edited

Loading

Uh oh!

pprasha commented Mar 22, 2020

Uh oh!

wesbarnett commented Oct 7, 2021

Uh oh!

jklymak Oct 12, 2021

Uh oh!

jklymak commented Nov 8, 2021

Uh oh!

tfpf commented Aug 12, 2022

Uh oh!

tfpf commented Aug 14, 2022

Uh oh!

timhoffm commented Aug 14, 2022

Uh oh!

github-actions bot commented Jun 30, 2023

Uh oh!

melissawm commented Jul 4, 2023

Uh oh!

rcomer commented Jul 4, 2023

Uh oh!

tfpf commented Jul 4, 2023

Uh oh!

wesbarnett commented Jul 5, 2023

Uh oh!

Uh oh!

Uh oh!

Add \underline to mathtext #15624

Add \underline to mathtext #15624

Uh oh!

Conversation

wesbarnett commented Nov 7, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

pprasha commented Mar 22, 2020

Uh oh!

wesbarnett commented Oct 7, 2021

Uh oh!

jklymak Oct 12, 2021

Choose a reason for hiding this comment

Uh oh!

jklymak commented Nov 8, 2021

Uh oh!

tfpf commented Aug 12, 2022

Uh oh!

tfpf commented Aug 14, 2022

Uh oh!

timhoffm commented Aug 14, 2022

Uh oh!

github-actions bot commented Jun 30, 2023

Uh oh!

melissawm commented Jul 4, 2023

Uh oh!

rcomer commented Jul 4, 2023

Uh oh!

tfpf commented Jul 4, 2023

Uh oh!

wesbarnett commented Jul 5, 2023

Uh oh!

Uh oh!

wesbarnett commented Nov 7, 2019 •

edited

Loading