Revision: 6594
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6594&view=rev
Author: mdboom
Date: 2008-12-12 21:22:04 +0000 (Fri, 12 Dec 2008)
Log Message:
-----------
Fix numerous documentation warnings.
Modified Paths:
--------------
trunk/matplotlib/doc/api/font_manager_api.rst
trunk/matplotlib/doc/faq/howto_faq.rst
trunk/matplotlib/doc/users/event_handling.rst
trunk/matplotlib/lib/matplotlib/artist.py
trunk/matplotlib/lib/matplotlib/axes.py
trunk/matplotlib/lib/matplotlib/collections.py
trunk/matplotlib/lib/matplotlib/colors.py
trunk/matplotlib/lib/matplotlib/lines.py
trunk/matplotlib/lib/matplotlib/mlab.py
trunk/matplotlib/lib/matplotlib/patches.py
trunk/matplotlib/lib/matplotlib/path.py
trunk/matplotlib/lib/matplotlib/pyplot.py
trunk/matplotlib/lib/matplotlib/text.py
trunk/matplotlib/lib/matplotlib/ticker.py
Modified: trunk/matplotlib/doc/api/font_manager_api.rst
===================================================================
--- trunk/matplotlib/doc/api/font_manager_api.rst 2008-12-12 17:23:57 UTC
(rev 6593)
+++ trunk/matplotlib/doc/api/font_manager_api.rst 2008-12-12 21:22:04 UTC
(rev 6594)
@@ -11,7 +11,7 @@
:show-inheritance:
:mod:`matplotlib.fontconfig_pattern`
-==============================
+====================================
.. automodule:: matplotlib.fontconfig_pattern
:members:
Modified: trunk/matplotlib/doc/faq/howto_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/howto_faq.rst 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/doc/faq/howto_faq.rst 2008-12-12 21:22:04 UTC (rev
6594)
@@ -428,8 +428,10 @@
.. seealso::
:ref:`howto-webapp`
+ For information about running matplotlib inside of a web
+ application.
-.. _howto-show
+.. _howto-show:
Use :func:`~matplotlib.pyplot.show`
------------------------------------------
Modified: trunk/matplotlib/doc/users/event_handling.rst
===================================================================
--- trunk/matplotlib/doc/users/event_handling.rst 2008-12-12 17:23:57 UTC
(rev 6593)
+++ trunk/matplotlib/doc/users/event_handling.rst 2008-12-12 21:22:04 UTC
(rev 6594)
@@ -64,8 +64,8 @@
'scroll_event' :class:`~matplotlib.backend_bases.MouseEvent` -
mouse scroll wheel is rolled
'figure_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` -
mouse enters a new figure
'figure_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` -
mouse leaves a figure
-'axes_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` -
mouse enters a new axes
-'axes_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` -
mouse leaves an axes
+'axes_enter_event' :class:`~matplotlib.backend_bases.LocationEvent` -
mouse enters a new axes
+'axes_leave_event' :class:`~matplotlib.backend_bases.LocationEvent` -
mouse leaves an axes
=======================
======================================================================================
.. _event-attributes:
Modified: trunk/matplotlib/lib/matplotlib/artist.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/artist.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/artist.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -144,7 +144,10 @@
Remove a callback based on its *id*.
.. seealso::
+
:meth:`add_callback`
+ For adding callbacks
+
"""
try: del self._propobservers[oid]
except KeyError: pass
@@ -497,7 +500,7 @@
def set_alpha(self, alpha):
"""
Set the alpha value used for blending - not supported on
- all backends
+ all backends.
ACCEPTS: float (0.0 transparent through 1.0 opaque)
"""
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/axes.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -43,8 +43,9 @@
* 'r--': red dashed lines
.. seealso::
+
:func:`~matplotlib.Line2D.lineStyles` and
- :func:`~matplotlib.pyplot.colors`:
+ :func:`~matplotlib.pyplot.colors`
for all possible styles and color format string.
"""
@@ -2574,7 +2575,8 @@
ACCEPTS: str
.. seealso::
- :meth:`text`:
+
+ :meth:`text`
for information on how override and the optional args work
"""
default = {
@@ -2610,7 +2612,8 @@
ACCEPTS: str
.. seealso::
- :meth:`text`:
+
+ :meth:`text`
for information on how override and the optional args work
"""
@@ -2641,7 +2644,8 @@
ACCEPTS: str
.. seealso::
- :meth:`text`:
+
+ :meth:`text`
for information on how override and the optional args work
"""
label = self.yaxis.get_label()
@@ -2794,7 +2798,8 @@
%(Line2D)s
.. seealso::
- :meth:`axhspan`:
+
+ :meth:`axhspan`
for example plot and source code
"""
@@ -2853,7 +2858,8 @@
%(Line2D)s
.. seealso::
- :meth:`axhspan`:
+
+ :meth:`axhspan`
for example plot and source code
"""
@@ -2964,7 +2970,8 @@
%(Polygon)s
.. seealso::
- :meth:`axhspan`:
+
+ :meth:`axhspan`
for example plot and source code
"""
trans = mtransforms.blended_transform_factory(
@@ -3331,12 +3338,13 @@
%(Line2D)s
.. seealso::
- :mod:`~matplotlib.dates`:
+
+ :mod:`~matplotlib.dates`
for helper functions
:func:`~matplotlib.dates.date2num`,
:func:`~matplotlib.dates.num2date` and
- :func:`~matplotlib.dates.drange`:
+ :func:`~matplotlib.dates.drange`
for help on creating the required floating point
dates.
"""
@@ -3439,7 +3447,8 @@
%(Line2D)s
.. seealso::
- :meth:`loglog`:
+
+ :meth:`loglog`
For example code and figure
"""
if not self._hold: self.cla()
@@ -3484,7 +3493,8 @@
%(Line2D)s
.. seealso::
- :meth:`loglog`:
+
+ :meth:`loglog`
For example code and figure
"""
if not self._hold: self.cla()
@@ -3546,9 +3556,10 @@
- *b* is the *x*-axis.
.. seealso::
+
:meth:`~matplotlib.axes.Axes.plot` or
- :meth:`~matplotlib.axes.Axes.vlines`: For documentation on
- valid kwargs.
+ :meth:`~matplotlib.axes.Axes.vlines`
+ For documentation on valid kwargs.
**Example:**
@@ -4249,11 +4260,13 @@
*baseline*).
.. seealso::
- `this document`__ for details
- :file:`examples/pylab_examples/stem_plot.py`:
- for a demo
+ `this document`__
+ for details
+ :file:`examples/pylab_examples/stem_plot.py`
+ for a demo
+
__ http://www.mathworks.com/access/helpdesk/help/techdoc/ref/stem.html
"""
@@ -5594,7 +5607,7 @@
%(PolyCollection)s
- .. plot:: mpl_examples/pylab_examples/fill_between.py
+ .. plot:: mpl_examples/pylab_examples/fill_between.py
"""
# Handle united data, such as dates
self._process_unit_info(xdata=x, ydata=y1, kwargs=kwargs)
@@ -6093,7 +6106,8 @@
%(QuadMesh)s
.. seealso::
- :func:`~matplotlib.pyplot.pcolor`:
+
+ :func:`~matplotlib.pyplot.pcolor`
For an explanation of the grid orientation and the
expansion of 1-D *X* and/or *Y* to 2-D arrays.
"""
@@ -6424,7 +6438,7 @@
def hist(self, x, bins=10, range=None, normed=False, weights=None,
cumulative=False, bottom=None, histtype='bar', align='mid',
- orientation='vertical', rwidth=None, log=False,
+ orientation='vertical', rwidth=None, log=False,
**kwargs):
"""
call signature::
@@ -6896,6 +6910,7 @@
.. plot:: mpl_examples/pylab_examples/csd_demo.py
.. seealso:
+
:meth:`psd`
For a description of the optional parameters.
"""
@@ -7093,7 +7108,9 @@
* *alpha*
.. seealso::
+
:func:`~matplotlib.pyplot.imshow`
+ For image options.
For controlling colors, e.g. cyan background and red marks,
use::
@@ -7114,7 +7131,9 @@
* ',' pixel
.. seealso::
+
:func:`~matplotlib.pyplot.plot`
+ For plotting options
"""
if precision is None:
precision = 0
Modified: trunk/matplotlib/lib/matplotlib/collections.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/collections.py 2008-12-12 17:23:57 UTC
(rev 6593)
+++ trunk/matplotlib/lib/matplotlib/collections.py 2008-12-12 21:22:04 UTC
(rev 6594)
@@ -354,7 +354,9 @@
ACCEPTS: matplotlib color arg or sequence of rgba tuples
.. seealso::
+
:meth:`set_facecolor`, :meth:`set_edgecolor`
+ For setting the edge or face color individually.
"""
self.set_facecolor(c)
self.set_edgecolor(c)
@@ -702,8 +704,8 @@
over the regions in *x* where *where* is True. The bars range
on the y-axis from *ymin* to *ymax*
- A :class:`BrokenBarHCollection` is returned.
- **kwargs are passed on to the collection
+ A :class:`BrokenBarHCollection` is returned. kwargs are
+ passed on to the collection.
"""
xranges = []
for ind0, ind1 in mlab.contiguous_regions(where):
@@ -932,7 +934,7 @@
Set the color(s) of the line collection. *c* can be a
matplotlib color arg (all patches have same color), or a
sequence or rgba tuples; if it is a sequence the patches will
- cycle through the sequence
+ cycle through the sequence.
ACCEPTS: matplotlib color arg or sequence of rgba tuples
"""
Modified: trunk/matplotlib/lib/matplotlib/colors.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/colors.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/colors.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -594,7 +594,9 @@
.. seealso::
+
:func:`makeMappingArray`
+ For information about making a mapping array.
"""
self.monochrome = False # True only if all colors in map are
identical;
# needed for contouring.
Modified: trunk/matplotlib/lib/matplotlib/lines.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/lines.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/lines.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -622,7 +622,9 @@
backward-compatibility.
.. seealso::
+
:meth:`set_drawstyle`
+ To set the drawing style (stepping) of the plot.
ACCEPTS: [ '-' | '--' | '-.' | ':' | 'None' | ' ' | '' ] and
any drawstyle in combination with a linestyle, e.g. 'steps--'.
Modified: trunk/matplotlib/lib/matplotlib/mlab.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/mlab.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/mlab.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -59,7 +59,7 @@
A collection of helper methods for numpyrecord arrays
-.. _htmlonly::
+.. _htmlonly:
See :ref:`misc-examples-index`
@@ -475,7 +475,8 @@
segments.
.. seealso::
- :func:`psd`:
+
+ :func:`psd`
:func:`psd` differs in the default overlap; in returning
the mean of the segment periodograms; and in not returning
times.
@@ -517,7 +518,8 @@
the factors cancel out.
.. seealso::
- :func:`psd` and :func:`csd`:
+
+ :func:`psd` and :func:`csd`
For information about the methods used to compute
:math:`P_{xy}`, :math:`P_{xx}` and :math:`P_{yy}`.
"""
@@ -565,7 +567,7 @@
Do a best fit polynomial of order *N* of *y* to *x*. Return value
is a vector of polynomial coefficients [pk ... p1 p0]. Eg, for
- *N*=2::
+ *N* = 2::
p2*x0^2 + p1*x0 + p0 = y1
p2*x1^2 + p1*x1 + p0 = y1
@@ -601,7 +603,9 @@
subscripts on that page. The linear algebra is correct, however.
.. seealso::
+
:func:`polyval`
+ polyval function
"""
warnings.warn("use numpy.poyfit", DeprecationWarning)
return np.polyfit(*args, **kwargs)
@@ -623,7 +627,9 @@
resid = y - trend
.. seealso::
+
:func:`polyfit`
+ polyfit function
"""
warnings.warn("use numpy.polyval", DeprecationWarning)
return np.polyval(*args, **kwargs)
@@ -709,7 +715,8 @@
cohere.
.. seealso::
- :file:`test/cohere_pairs_test.py` in the src tree:
+
+ :file:`test/cohere_pairs_test.py` in the src tree
For an example script that shows that this
:func:`cohere_pairs` and :func:`cohere` give the same
results for a given pair.
@@ -1212,10 +1219,11 @@
\lambda = \\frac{1}{n}\\sum \\ln|f^'(x_i)|
.. seealso::
- Sec 10.5 Strogatz (1994) "Nonlinear Dynamics and Chaos".
- `Wikipedia article on Lyapunov Exponent
- <http://en.wikipedia.org/wiki/Lyapunov_exponent>`_.
+ Lyapunov Exponent
+ Sec 10.5 Strogatz (1994) "Nonlinear Dynamics and Chaos".
+ `Wikipedia article on Lyapunov Exponent
+ <http://en.wikipedia.org/wiki/Lyapunov_exponent>`_.
.. note::
What the function here calculates may not be what you really want;
@@ -1426,7 +1434,8 @@
- *dtype*: the array will have this dtype. default: ``numpy.float_``
.. seealso::
- See :file:`examples/pylab_examples/load_converter.py` in the source
tree:
+
+ See :file:`examples/pylab_examples/load_converter.py` in the source
tree
Exercises many of these options.
"""
@@ -2057,6 +2066,7 @@
.. seealso::
http://projects.scipy.org/pipermail/numpy-discussion/2008-August/036429.html
+ Motivation for this function
"""
return rec.view(np.recarray)
#return rec.view(dtype=(np.record, rec.dtype), type=np.recarray)
@@ -2815,7 +2825,8 @@
files is automatic, if the filename ends in '.gz'
.. seealso::
- :func:`csv2rec`:
+
+ :func:`csv2rec`
For information about *missing* and *missingd*, which can
be used to fill in masked values into your CSV file.
"""
Modified: trunk/matplotlib/lib/matplotlib/patches.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/patches.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/patches.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -643,8 +643,10 @@
%(Patch)s
.. seealso::
- :class:`Patch`:
+
+ :class:`Patch`
For additional kwargs
+
"""
Patch.__init__(self, **kwargs)
self._path = path
@@ -671,8 +673,10 @@
%(Patch)s
.. seealso::
- :class:`Patch`:
+
+ :class:`Patch`
For additional kwargs
+
"""
Patch.__init__(self, **kwargs)
xy = np.asarray(xy, np.float_)
Modified: trunk/matplotlib/lib/matplotlib/path.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/path.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/path.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -223,7 +223,8 @@
Return a transformed copy of the path.
.. seealso::
- :class:`matplotlib.transforms.TransformedPath`:
+
+ :class:`matplotlib.transforms.TransformedPath`
A specialized path class that will cache the
transformed result and automatically update when the
transform changes.
Modified: trunk/matplotlib/lib/matplotlib/pyplot.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/pyplot.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/pyplot.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -425,7 +425,8 @@
'upper right' )
.. seealso::
- :func:`~matplotlib.pyplot.legend`:
+
+ :func:`~matplotlib.pyplot.legend`
For information about the location codes
"""
l = gcf().legend(handles, labels, loc, **kwargs)
@@ -616,11 +617,13 @@
registered. See :func:`matplotlib.projections.register_projection`
.. seealso::
- :func:`~matplotlib.pyplot.axes`:
+
+ :func:`~matplotlib.pyplot.axes`
For additional information on :func:`axes` and
:func:`subplot` keyword arguments.
:file:`examples/pylab_examples/polar_scatter.py`
+ For an example
**Example:**
@@ -650,7 +653,9 @@
the right, and the *ax2* instance is returned.
.. seealso::
+
:file:`examples/api_examples/two_scales.py`
+ For an example
"""
if ax is None:
ax=gca()
@@ -746,7 +751,8 @@
'horizontalalignment': 'center'}
.. seealso::
- :func:`~matplotlib.pyplot.text`:
+
+ :func:`~matplotlib.pyplot.text`
for information on how override and the optional args work.
"""
l = gca().set_title(s, *args, **kwargs)
@@ -812,7 +818,9 @@
The xmin, xmax, ymin, ymax tuple is returned
.. seealso::
+
:func:`xlim`, :func:`ylim`
+ For setting the x- and y-limits individually.
"""
ax = gca()
v = ax.axis(*v, **kwargs)
@@ -832,7 +840,8 @@
}
.. seealso::
- :func:`~matplotlib.pyplot.text`:
+
+ :func:`~matplotlib.pyplot.text`
For information on how override and the optional args work
"""
l = gca().set_xlabel(s, *args, **kwargs)
@@ -852,7 +861,8 @@
'rotation'='vertical' : }
.. seealso::
- :func:`~matplotlib.pyplot.text`:
+
+ :func:`~matplotlib.pyplot.text`
For information on how override and the optional args
work.
"""
@@ -1139,9 +1149,9 @@
"""
Plotting commands
- ========= =================================================
+ ============== =================================================
Command Description
- ========= =================================================
+ ============== =================================================
axes Create a new axes
axis Set or return the current axis limits
bar make a bar chart
@@ -1162,7 +1172,7 @@
figtext add text in figure coords
figure create or change active figure
fill make filled polygons
- fill_between make filled polygons
+ fill_between make filled polygons
gca return the current axes
gcf return the current figure
gci get the current image, or None
@@ -1194,7 +1204,7 @@
title add a title to the current axes
xlabel add an xlabel to the current axes
ylabel add a ylabel to the current axes
- ========= =================================================
+ ============== =================================================
The following commands will set the default colormap accordingly:
Modified: trunk/matplotlib/lib/matplotlib/text.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/text.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/text.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -658,7 +658,9 @@
Set the background color of the text by updating the bbox.
.. seealso::
+
:meth:`set_bbox`
+ To change the position of the bounding box.
ACCEPTS: any matplotlib color
"""
Modified: trunk/matplotlib/lib/matplotlib/ticker.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/ticker.py 2008-12-12 17:23:57 UTC (rev
6593)
+++ trunk/matplotlib/lib/matplotlib/ticker.py 2008-12-12 21:22:04 UTC (rev
6594)
@@ -213,7 +213,7 @@
'Return fixed strings for tick labels'
def __init__(self, seq):
"""
- seq is a sequence of strings. For positions ``i<len(seq)` return
+ *seq* is a sequence of strings. For positions ``i < len(seq)`` return
*seq[i]* regardless of *x*. Otherwise return ''
"""
self.seq = seq
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
SF.Net email is Sponsored by MIX09, March 18-20, 2009 in Las Vegas, Nevada.
The future of the web can't happen without you. Join us at MIX09 to help
pave the way to the Next Web now. Learn more and register at
http://ad.doubleclick.net/clk;208669438;13503038;i?http://2009.visitmix.com/
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
