Issue #1888: added in the \dfrac macro for displaystyle fractions #8151

watkinrt · 2017-02-26T02:13:35Z

This is a partial fix for issue #1888. The implementation of \dfrac{}{} addresses the issue of creating fractions with displaystyle formatting (which the author of #1888 would like to be able to do); however, it does not implement the more generic \displaystyle functionality as explicitly requested in #1888 (I've begun coding this up, but it is reasonably involved and has a number of pitfalls).

I added in an example script (dfrac_demo.py) to demonstrate the new functionality.

…ion) to the mathtex implementation.

dstansby · 2017-02-26T11:34:47Z

There's a couple of PEP8 violations in the test - some trailing whitespace at the end of the lines, and no newline at the end of the file (see https://travis-ci.org/matplotlib/matplotlib/jobs/205418695#L1677)

tacaswell · 2017-02-26T16:53:18Z

examples/text_labels_and_annotations/dfrac_demo.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python2


remove the pinning to python2

Will do. This is my first contribution, so I'm still working out some of the bugs. Thanks for the prompt suggestions.

tacaswell · 2017-02-26T16:57:55Z

Can you please add a test to https://github.com/matplotlib/matplotlib/blob/master/lib/matplotlib/tests/test_mathtext.py#L17 to cover this case?

Over all 👍 thanks for working on this!

tacaswell · 2017-02-26T17:01:03Z

To get the test images you will have to add the test, run the test suite, let if it fail on a missing image, then copy output into tests/baseline_images/test_mathtext and commit them (see http://matplotlib.org/devel/testing.html#writing-an-image-comparison-test)

You will also need to be sure to be testing against the correct version of freetype (see http://matplotlib.org/devel/contributing.html#retrieving-and-installing-the-latest-version-of-the-code)

QuLogic · 2017-02-26T21:21:53Z

examples/text_labels_and_annotations/dfrac_demo.py

+#!/usr/bin/env python2
+# -*- coding: utf-8 -*-
+"""
+Created on Sat Feb 25 17:50:37 2017


Remove this date; we have git log for that. Can you please modify the docstring to follow the sphinx-gallery format?

QuLogic · 2017-02-26T21:22:02Z

examples/text_labels_and_annotations/dfrac_demo.py

+fig.text(0.5, 0.3, r'\dfrac: $\dfrac{a}{b}$',
+         horizontalalignment='center', verticalalignment='center')
+fig.text(0.5, 0.7, r'\frac: $\frac{a}{b}$',
+         horizontalalignment='center', verticalalignment='center')


Needs plt.show at the end.

Man, you guys are fast and thorough. I'm working on all of the requested changes.

QuLogic · 2017-02-26T21:23:11Z

lib/matplotlib/mathtext.py

-        assert(len(toks)==1)
-        assert(len(toks[0])==6)
+        assert(len(toks) == 1)
+        assert(len(toks[0]) == 6)


👍 for the whitespace fix, but also, you don't really need the parentheses.

Bug fix: I added a plt.show() to the end of the dfrac_demo Tests: I added in a new test for the dfrac macro (along with the corresponding comparison files) within the test_mathtex test suite.

QuLogic · 2017-02-28T02:51:02Z

examples/text_labels_and_annotations/dfrac_demo.py

@@ -0,0 +1,28 @@
+"""


This needs to be a raw string or all the backslashes need to be escaped (which probably won't look that great.)

QuLogic · 2017-02-28T08:04:15Z

lib/matplotlib/mathtext.py

-        num.shrink()
-        den.shrink()
+
+        # If style != displaystyle == 0, shrink the num and den


I think these warrant some constants instead of magic numbers.

…string with the backslashes escaped. Feature modification: I added in a dictionary to the Parser class of mathtex to link math style names to their TeX numerical values. I used a dictionary instead of hardcoding specific math style (ex. DISPLAYSTYLE=0) as I will use the dictionary in my implementation of the math styles in the future.

tacaswell · 2017-03-02T04:58:07Z

''power-cycled' to trigger travis.

QuLogic · 2017-03-02T05:12:22Z

It needs to be a raw string or escaped backslashes, not both.

watkinrt · 2017-03-02T05:21:14Z

Am I missing something? The reStructuredText documents make it sound like you need to make the text is a raw string to properly pass the backslashes out of python, but that you still need to escape the backslashs for the reStructuredText to be parsed correctly (http://docutils.sourceforge.net/docs/user/rst/quickref.html#escaping).

QuLogic · 2017-03-25T04:18:02Z

At this point, we don't actually render any of that text through Sphinx. After #8247 is merged, then maybe it will be clearer what should be done.

… as matplotlib doesn't currently support this behavior in docstrings.

anntzer · 2017-04-16T05:57:09Z

examples/text_labels_and_annotations/dfrac_demo.py

+
+In this example, the differences between the \dfrac and \frac TeX macros are
+illustrated; in particular, the difference between display style and text style
+fractions when using Mathtex. aasdsads


mathtext
remove whatever aasdsads is

QuLogic · 2017-04-30T01:59:07Z

Do you want to have a go at rebasing this? The sphinx-gallery stuff is merged now, so we should be able to see whether the escaping is going to be a problem.

watkinrt · 2017-05-03T16:23:16Z

I should be able to get to it this weekend. From: Elliott Sales de Andrade [mailto:[email protected]] Sent: Saturday, April 29, 2017 6:59 PM To: matplotlib/matplotlib <[email protected]> Cc: watkinrt <[email protected]>; Author <[email protected]> Subject: Re: [matplotlib/matplotlib] Issue #1888: added in the \dfrac macro for displaystyle fractions (#8151) Do you want to have a go at rebasing this? The sphinx-gallery stuff is merged now, so we should be able to see whether the escaping is going to be a problem. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#8151 (comment)> , or mute the thread <https://github.com/notifications/unsubscribe-auth/AJOpOow9GKBCK071d-GYgDAdvAzyATYmks5r0-rzgaJpZM4MMNdy> . <https://github.com/notifications/beacon/AJOpOsPRc2Xusy1JeANi2fGQGzmj8RWYks5r0-rzgaJpZM4MMNdy.gif>

…and updated the docstring to appropriately escape the backslashes.

tacaswell · 2017-07-05T19:22:07Z

It looks like some of the new required test images did not get added

_________________ test_mathtext_rendering[png-mathtext-cm-82] __________________
[gw1] linux -- Python 3.4.6 /home/travis/build/matplotlib/matplotlib/venv/bin/python
self = <matplotlib.testing.decorators._ImageComparisonBase object at 0x7fffe12af160>
baseline = 'mathtext_cm_82', extension = 'png'
    def copy_baseline(self, baseline, extension):
        baseline_path = os.path.join(self.baseline_dir, baseline)
        orig_expected_fname = baseline_path + '.' + extension
        if extension == 'eps' and not os.path.exists(orig_expected_fname):
            orig_expected_fname = baseline_path + '.pdf'
        expected_fname = make_test_filename(os.path.join(
            self.result_dir, os.path.basename(orig_expected_fname)), 'expected')
        if os.path.exists(orig_expected_fname):
            shutil.copyfile(orig_expected_fname, expected_fname)
        else:
            reason = ("Do not have baseline image {0} because this "
                      "file does not exist: {1}".format(expected_fname,
                                                        orig_expected_fname))
>           raise ImageComparisonFailure(reason)
E           matplotlib.testing.exceptions.ImageComparisonFailure: Do not have baseline image /home/travis/build/matplotlib/matplotlib/result_images/test_mathtext/mathtext_cm_82-expected.png because this file does not exist: /home/travis/build/matplotlib/matplotlib/lib/matplotlib/tests/baseline_images/test_mathtext/mathtext_cm_82.png
lib/matplotlib/testing/decorators.py:271: ImageComparisonFailure

I suspect the issue is missing optional dependencies on the local system where the test images were generated. @watkinrt I can try to generate them and push to this branch or you can sort out which deps you are missing (my guess is LaTeX?), which ever you would prefer.

watkinrt · 2017-07-07T20:09:35Z

@watkinrt I can try to generate them and push to this branch or you can sort out which deps you are missing (my guess is LaTeX?), which ever you would prefer.

I just realized I hadn't fetched the master branch from the main matplotlib repository in a while; I image that is why I was missing some of the new test images. I've updated my working copy and just pushed it. I haven't been able to successfully run the full test suite on this commit as something is messed up with the my development copy of matplotlib. If someone else has time, would you mind running the tests? I'm not sure when I'll be able to get around to fixing my development copy.

Sorry for all of my newbiew mistakes; this is the first large scale repository/team I've worked on.

QuLogic · 2017-07-15T21:58:57Z

It's preferable to rebase instead of merging master. However, the tests are failing because it looks like you forgot to commit the image for the new test.

tacaswell · 2017-07-16T16:06:39Z

@watkinrt I'll try to generate those test images for you now and push to your branch.

With your permission I can do the rebase for you (and force-push to your branch).

Don't worry about small process mistakes, we were all new once!

tacaswell · 2017-07-16T16:39:23Z

I pushed a commit and then almost immediately force-pushed a fixed version of it (accidentally committed a temporary file). Hopefully no one fetched between the two pushes, but if you did, that is the source of any issue.

tacaswell · 2017-07-17T03:37:35Z

Looks like this is passing now and the test images look good!

watkinrt · 2017-07-20T05:41:50Z

Great! Thanks for closing all of this out. Hopefully that wraps everything up for this pull request.

tacaswell · 2017-07-26T01:32:18Z

@QuLogic I think this is ready to go, can you give this another review or dismiss your change request?

tacaswell · 2017-07-28T02:33:00Z

@watkinrt Thanks and congratulations on what (I think) is your first Matplotlib contribution 🎉 !

Thanks for taking on one of the more arcane bits of the code base and bearing with us through a very long review process!

Hopefully we will hear from you again.

breedlun · 2019-02-21T02:45:58Z

Wow, this is great, @watkinrt ! I had no idea you had finished this almost 2 years ago!

Feature addition: I added in the the \dfrac macro (displaystyle fract…

4b9ff60

…ion) to the mathtex implementation.

dstansby added the topic: text label Feb 26, 2017

dstansby added this to the 2.1 (next point release) milestone Feb 26, 2017

PEP8 fixes

45f5d63

tacaswell reviewed Feb 26, 2017

View reviewed changes

QuLogic requested changes Feb 26, 2017

View reviewed changes

Documentation: Updated the docstring for the dfrac_demo

bedfdc0

Bug fix: I added a plt.show() to the end of the dfrac_demo Tests: I added in a new test for the dfrac macro (along with the corresponding comparison files) within the test_mathtex test suite.

QuLogic reviewed Feb 28, 2017

View reviewed changes

tacaswell closed this Mar 2, 2017

tacaswell reopened this Mar 2, 2017

Although Sphyinx requires "\\" to show "\" characters, I removed them…

2c9b9bc

… as matplotlib doesn't currently support this behavior in docstrings.

anntzer reviewed Apr 16, 2017

View reviewed changes

Remove stray text from documentation.

57fd910

With the resent merging of the sphinx-gallery branch, I went through …

d0cfe37

…and updated the docstring to appropriately escape the backslashes.

Merge remote-tracking branch 'master/master' into dfrac

7781dbd

TST: add missing tests

b80d975

tacaswell force-pushed the dfrac branch from f034f95 to b80d975 Compare July 16, 2017 16:38

tacaswell approved these changes Jul 26, 2017

View reviewed changes

QuLogic merged commit c45678e into matplotlib:master Jul 26, 2017

anntzer mentioned this pull request Aug 8, 2019

Feature request: mathtext support for \displaystyle #1888

Closed

QuLogic mentioned this pull request Sep 24, 2020

Convert _math_style_dict into an Enum. #18555

Merged

3 tasks

aitikgupta mentioned this pull request Nov 8, 2020

Add overset and underset support for mathtext #18916

Merged

7 tasks

tfpf mentioned this pull request May 8, 2022

[ENH]: Use \genfrac in display style? #23008

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Issue #1888: added in the \dfrac macro for displaystyle fractions #8151

Issue #1888: added in the \dfrac macro for displaystyle fractions #8151

watkinrt commented Feb 26, 2017

dstansby commented Feb 26, 2017

tacaswell Feb 26, 2017

watkinrt Feb 26, 2017

tacaswell commented Feb 26, 2017

tacaswell commented Feb 26, 2017

QuLogic Feb 26, 2017

QuLogic Feb 26, 2017

watkinrt Feb 26, 2017

QuLogic Feb 26, 2017

QuLogic Feb 28, 2017

QuLogic Feb 28, 2017

tacaswell commented Mar 2, 2017

QuLogic commented Mar 2, 2017

watkinrt commented Mar 2, 2017

QuLogic commented Mar 25, 2017

anntzer Apr 16, 2017 •

edited

Loading

QuLogic commented Apr 30, 2017

watkinrt commented May 3, 2017 via email

tacaswell commented Jul 5, 2017

watkinrt commented Jul 7, 2017 •

edited

Loading

QuLogic commented Jul 15, 2017

tacaswell commented Jul 16, 2017

tacaswell commented Jul 16, 2017

tacaswell commented Jul 17, 2017

watkinrt commented Jul 20, 2017

tacaswell commented Jul 26, 2017

tacaswell commented Jul 28, 2017

breedlun commented Feb 21, 2019

Issue #1888: added in the \dfrac macro for displaystyle fractions #8151

Issue #1888: added in the \dfrac macro for displaystyle fractions #8151

Conversation

watkinrt commented Feb 26, 2017

dstansby commented Feb 26, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tacaswell commented Feb 26, 2017

tacaswell commented Feb 26, 2017

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

tacaswell commented Mar 2, 2017

QuLogic commented Mar 2, 2017

watkinrt commented Mar 2, 2017

QuLogic commented Mar 25, 2017

anntzer Apr 16, 2017 • edited Loading

Choose a reason for hiding this comment

QuLogic commented Apr 30, 2017

watkinrt commented May 3, 2017 via email

tacaswell commented Jul 5, 2017

watkinrt commented Jul 7, 2017 • edited Loading

QuLogic commented Jul 15, 2017

tacaswell commented Jul 16, 2017

tacaswell commented Jul 16, 2017

tacaswell commented Jul 17, 2017

watkinrt commented Jul 20, 2017

tacaswell commented Jul 26, 2017

tacaswell commented Jul 28, 2017

breedlun commented Feb 21, 2019

anntzer Apr 16, 2017 •

edited

Loading

watkinrt commented Jul 7, 2017 •

edited

Loading