wrap matplotlib's title functionality

[jasongrout]

We should wrap matplotlib's ability to add titles to axes, perhaps as an option to show.

http://matplotlib.sourceforge.net/api/pyplot_api.html#matplotlib.pyplot.title

http://matplotlib.sourceforge.net/api/pyplot_api.html#matplotlib.pyplot.suptitle

---

Apply attachment: trac-10512-plot-title.1.patch and attachment: trac_10512_review-sl.patch to devel/sage

CC: @kcrisman @seblabbe

Component: graphics

Author: Jason Grout, Punarbasu Purkayastha, Sébastien Labbé

Reviewer: Sébastien Labbé, Punarbasu Purkayastha

Merged: sage-5.3.beta2

Issue created by migration from https://trac.sagemath.org/ticket/10512

[jasongrout]

Attachment: trac-10512-plot-title.patch.gz

[jasongrout]

comment:2

I've attached a patch. There is still an issue that needs to be solved, though. In this plot:

plot(sin(x^2), (x, -3, 3), title='Plot of sin(x)', axes_labels=['x','y'],frame=True)

the title overwrites the axis label. Maybe the axis label should be smarter here, or the plot title should be slightly adjusted up in this situation.

[seblabbe]

comment:4

plot(sin(x^2), (x, -3, 3), title='Plot of sin(x)', axes_labels=['x','y'],frame=True)

I get no problem when frame=True but do get the described problem when frame=False.

Sébastien

[ppurka]

Author: Jason Grout

[ppurka]

comment:5

Updated the patch to sage-5.2 and fixed the positioning of the title. Please review.

[ppurka]

updated to sage-5.2, fixed position

[ppurka]

comment:6

Attachment: trac-10512-plot-title.1.patch.gz

There was a small typo in the backticks used around the title docstring. Fixed it now.

[seblabbe]

Applies over the preceding patche

[seblabbe]

comment:7

Attachment: trac_10512_review-sl.patch.gz

I added a patch which adds a doctest about the fact that

plot(sin(x^2), (x, -3, 3), title='Plot of sin(x^2)', axes_labels=['x','y'],frame=True)

should be ok (no overlap between title and axes labels). I know the doctest system won't see in the future if it is not the case, but at least the documentation will recall it.

Also added some x^2 in title instead of x.

My patch needs review.

I tested ppurka patch. All tests passed on sage/combinat/graphics.py and plot.py. Documentation builds fine. I give a positive review to his patch.

BTW I am wondering why ppurka started from scratch instead of applying a patch over jason's one? Jason work will not appear in the log...

[ppurka]

comment:9

Hello, the patch still contains Jason's name in the patch header. The patch fails in many places in 5.2, and I had to move many of the patch lines from plot.py to graphics.py. Otherwise the code is almost the same as what Jason had.

[ppurka]

Changed author from Jason Grout to Jason Grout, Punarbasu Purkayastha, Sebastien Labbe

[ppurka]

Reviewer: Sebastien Labbe, Punarbasu Purkayastha

[ppurka]

comment:10

Thanks for the patch. That was a good catch on the typos. :) Positive review from me.

I see now what you actually meant in comment:7. I am setting the authors as all three of us. That should be good enough.

[jdemeyer]

Merged: sage-5.3.beta2

[jdemeyer]

Changed reviewer from Sebastien Labbe, Punarbasu Purkayastha to Sébastien Labbé, Punarbasu Purkayastha

[jdemeyer]

Changed author from Jason Grout, Punarbasu Purkayastha, Sebastien Labbe to Jason Grout, Punarbasu Purkayastha, Sébastien Labbé

[kcrisman]

comment:13

Replying to @jasongrout:

I've attached a patch. There is still an issue that needs to be solved, though. In this plot:

plot(sin(x^2), (x, -3, 3), title='Plot of sin(x)', axes_labels=['x','y'],frame=True)

the title overwrites the axis label. Maybe the axis label should be smarter here, or the plot title should be slightly adjusted up in this situation.

It turns out that this happens in matrix plots as well, even with this code (because it has a frame). See this ask.sagemath.org question. I've opened #13625 for this.