Fix documentation warnings #1108

Merged
merged 2 commits into from Aug 20, 2012

2 participants

@mdboom
Matplotlib Developers member

Fixes a number of documentation warnings and problems in master.

Fixes #892.

@pelson pelson and 1 other commented on an outdated diff Aug 19, 2012
lib/matplotlib/axes.py
@@ -4432,8 +4432,7 @@ def legend(self, *args, **kwargs):
instance. If *prop* is a dictionary, a new instance will be
created with *prop*. If *None*, use rc settings.
- *fontsize*: [ size in points | 'xx-small' | 'x-small' | 'small' |
- 'medium' | 'large' | 'x-large' | 'xx-large' ]
+ *fontsize*: [ size in points | 'xx-small' | 'x-small' | 'small' | 'medium' | 'large' | 'x-large' | 'xx-large' ]
@pelson
Matplotlib Developers member
pelson added a note Aug 19, 2012

Do we normally wrap these?

@mdboom
Matplotlib Developers member
mdboom added a note Aug 19, 2012

It would be nice to, but doing so results in Sphinx warnings and incorrect rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@pelson pelson commented on the diff Aug 19, 2012
lib/matplotlib/axes.py
@@ -7828,6 +7827,8 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
ax.hist(12+3*np.random.randn(1000), label='women', alpha=0.5)
ax.legend()
+ .
@pelson
Matplotlib Developers member
pelson added a note Aug 19, 2012

???

@mdboom
Matplotlib Developers member
mdboom added a note Aug 19, 2012

When you have a literal block, you have to have a closing point at the same level on indentation from where it started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@pelson pelson commented on an outdated diff Aug 19, 2012
lib/matplotlib/axes.py
- The return value is (counts,xedges,yedges,Image)
+ The return value is `(counts, xedges, yedges, Image)`.
@pelson
Matplotlib Developers member
pelson added a note Aug 19, 2012

Double back quotes needed to render as a code block.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@pelson pelson commented on an outdated diff Aug 19, 2012
lib/matplotlib/stackplot.py
*y* : 2d array of dimension MxN, OR any number 1d arrays each of dimension
1xN. The data is assumed to be unstacked. Each of the following
- calls is legal:
+ calls is legal::
stackplot(x, y) # where y is MxN
@pelson
Matplotlib Developers member
pelson added a note Aug 19, 2012

does this need indentation?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@pelson pelson commented on the diff Aug 19, 2012
doc/mpl_toolkits/mplot3d/tutorial.rst
@@ -68,7 +68,7 @@ Surface plots
Tri-Surface plots
=================
-.. automethod:: Axes3D.plot_trisurface
+.. automethod:: Axes3D.plot_trisurf
@pelson
Matplotlib Developers member
pelson added a note Aug 19, 2012

Intentional (I've not been following trisurf/trisurface)?

@mdboom
Matplotlib Developers member
mdboom added a note Aug 19, 2012

As far as I can tell, this was a typo in the docs. There has never been a method called trisurface.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@pelson pelson merged commit dc535b4 into matplotlib:master Aug 20, 2012
@mdboom mdboom deleted the mdboom:fix_doc_warnings branch Mar 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment