Error in doc?

Community matplotlib-users
1

Hi,
I think I found a bug, but I am not sure if it's in the doc or in a method name.
In the doc, there is reference to a method *suptitle* in class
mpl.figure.Figure. The name sounds strange, but the method exists and works. The
example given, though, makes reference to *subtitle*, so either the example or
the method name are wrong. Here's the link to the doc:
http://matplotlib.sourceforge.net/api/figure_api.html?highlight=legend#matplotlib.figure.Figure.suptitle

jorge

2

Hi list,

I can confirm this difference for current SVN (Last Changed Rev: 7802, see
attachement), too.
Maybe some of the developers could correct the subtle error.

Kind regards,
Matthias

suptitle_vs_subtitle.txt (2.13 KB)

···

On Wednesday 09 September 2009 17:10:43 Jorge Scandaliaris wrote:

Hi,
I think I found a bug, but I am not sure if it's in the doc or in a method
name. In the doc, there is reference to a method *suptitle* in class
mpl.figure.Figure. The name sounds strange, but the method exists and
works. The example given, though, makes reference to *subtitle*, so either
the example or the method name are wrong. Here's the link to the doc:
http://matplotlib.sourceforge.net/api/figure_api.html?highlight=legend#matp
lotlib.figure.Figure.suptitle

jorge

3

Done. suptitle is the correct name, as it’s kind of a “super” title that appears at the top of a figure with multiple panels, not a subtitle.

Thanks for catching this.

Ryan

···

On Mon, Sep 21, 2009 at 5:13 AM, Matthias Michler <MatthiasMichler@…361…> wrote:

On Wednesday 09 September 2009 17:10:43 Jorge Scandaliaris wrote:

Hi,

I think I found a bug, but I am not sure if it’s in the doc or in a method

name. In the doc, there is reference to a method suptitle in class

mpl.figure.Figure. The name sounds strange, but the method exists and

works. The example given, though, makes reference to subtitle, so either

the example or the method name are wrong. Here’s the link to the doc:

http://matplotlib.sourceforge.net/api/figure_api.html?highlight=legend#matp

lotlib.figure.Figure.suptitle

jorge

Hi list,

I can confirm this difference for current SVN (Last Changed Rev: 7802, see

attachement), too.

Maybe some of the developers could correct the subtle error.

–
Ryan May
Graduate Research Assistant
School of Meteorology
University of Oklahoma
Sent from Norman, Oklahoma, United States