From: <jd...@us...> - 2008-07-29 18:34:14
|
Revision: 5924 http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5924&view=rev Author: jdh2358 Date: 2008-07-29 18:34:11 +0000 (Tue, 29 Jul 2008) Log Message: ----------- trying in vein to get rid of acorr indent warning on doc build Modified Paths: -------------- trunk/matplotlib/lib/matplotlib/__init__.py trunk/matplotlib/lib/matplotlib/axes.py Modified: trunk/matplotlib/lib/matplotlib/__init__.py =================================================================== --- trunk/matplotlib/lib/matplotlib/__init__.py 2008-07-29 18:01:16 UTC (rev 5923) +++ trunk/matplotlib/lib/matplotlib/__init__.py 2008-07-29 18:34:11 UTC (rev 5924) @@ -89,7 +89,7 @@ """ from __future__ import generators -__version__ = '0.98.3rc1' +__version__ = '0.98.3rc2' __revision__ = '$Revision$' __date__ = '$Date$' Modified: trunk/matplotlib/lib/matplotlib/axes.py =================================================================== --- trunk/matplotlib/lib/matplotlib/axes.py 2008-07-29 18:01:16 UTC (rev 5923) +++ trunk/matplotlib/lib/matplotlib/axes.py 2008-07-29 18:34:11 UTC (rev 5924) @@ -3317,7 +3317,7 @@ """ call signature:: - acorr(x, normed=False, detrend=mlab.detrend_none, usevlines=False, + acorr(x, normed=False, detrend=mlab.detrend_none, usevlines=False, maxlags=None, **kwargs) Plot the autocorrelation of *x*. If *normed* = *True*, @@ -3328,32 +3328,30 @@ Return value is a tuple (*lags*, *c*, *line*) where: - - *lags* are a length 2*maxlags+1 lag vector + - *lags* are a length 2*maxlags+1 lag vector - - *c* is the 2*maxlags+1 auto correlation vector + - *c* is the 2*maxlags+1 auto correlation vector - - *line* is a :class:`~matplotlib.lines.Line2D` instance - returned by :meth:`plot` + - *line* is a :class:`~matplotlib.lines.Line2D` instance + returned by :meth:`plot` The default *linestyle* is None and the default *marker* is ``'o'``, though these can be overridden with keyword args. The cross correlation is performed with :func:`numpy.correlate` with *mode* = 2. - If *usevlines* is *True*: + If *usevlines* is *True*, :meth:`~matplotlib.axes.Axes.vlines` + rather than :meth:`~matplotlib.axes.Axes.plot` is used to draw + vertical lines from the origin to the acorr. Otherwise, the + plot style is determined by the kwargs, which are + :class:`~matplotlib.lines.Line2D` properties. The return + value is a tuple (*lags*, *c*, *linecol*, *b*) where - :meth:`~matplotlib.axes.Axes.vlines` rather than - :meth:`~matplotlib.axes.Axes.plot` is used to draw - vertical lines from the origin to the acorr. Otherwise, - the plot style is determined by the kwargs, which are - :class:`~matplotlib.lines.Line2D` properties. The return - value is a tuple (*lags*, *c*, *linecol*, *b*) where + - *linecol* is the + :class:`~matplotlib.collections.LineCollection` - - *linecol* is the - :class:`~matplotlib.collections.LineCollection` + - *b* is the *x*-axis. - - *b* is the *x*-axis. - *maxlags* is a positive integer detailing the number of lags to show. The default value of *None* will return all ``(2*len(x)-1)`` lags. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |