Revision: 5246
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5246&view=rev
Author: dsdale
Date: 2008-05-23 14:53:01 -0700 (Fri, 23 May 2008)
Log Message:
-----------
updating docstrings
Modified Paths:
--------------
trunk/matplotlib/lib/matplotlib/axes.py
trunk/matplotlib/lib/matplotlib/text.py
Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py 2008-05-23 20:32:56 UTC (rev
5245)
+++ trunk/matplotlib/lib/matplotlib/axes.py 2008-05-23 21:53:01 UTC (rev
5246)
@@ -2399,13 +2399,15 @@
def annotate(self, *args, **kwargs):
"""
- annotate(s, xy,
- xytext=None,
- xycoords='data',
- textcoords='data',
- arrowprops=None,
- **props)
+ call signature::
+ annotate(s, xy,
+ xytext=None,
+ xycoords='data',
+ textcoords='data',
+ arrowprops=None,
+ **props)
+
%(Annotation)s
"""
a = mtext.Annotation(*args, **kwargs)
@@ -2996,13 +2998,16 @@
def acorr(self, x, **kwargs):
"""
- ACORR(x, normed=False, detrend=mlab.detrend_none, usevlines=False,
- maxlags=None, **kwargs)
+ call signature::
+
+ acorr(x, normed=False, detrend=mlab.detrend_none, usevlines=False,
+ maxlags=None, **kwargs)
+
Plot the autocorrelation of x. If normed=True, normalize the
data but the autocorrelation at 0-th lag. x is detrended by
the detrend callable (default no normalization.
- data are plotted as plot(lags, c, **kwargs)
+ data are plotted as ``plot(lags, c, **kwargs)``
return value is lags, c, line where lags are a length
2*maxlags+1 lag vector, c is the 2*maxlags+1 auto correlation
@@ -3032,17 +3037,17 @@
def xcorr(self, x, y, normed=False, detrend=mlab.detrend_none,
usevlines=False,
maxlags=None, **kwargs):
"""
- XCORR(x, y, normed=False, detrend=mlab.detrend_none, usevlines=False,
**kwargs):
+ XCORR(x, y, normed=False, detrend=mlab.detrend_none, usevlines=False,
\*\*kwargs):
Plot the cross correlation between x and y. If normed=True,
normalize the data but the cross correlation at 0-th lag. x
and y are detrended by the detrend callable (default no
normalization. x and y must be equal length
- data are plotted as plot(lags, c, **kwargs)
+ data are plotted as ``plot(lags, c, **kwargs)``
return value is lags, c, line where lags are a length
- 2*maxlags+1 lag vector, c is the 2*maxlags+1 auto correlation
+ ``2*maxlags+1`` lag vector, c is the ``2*maxlags+1`` auto correlation
vector, and line is a Line2D instance returned by plot. The
default linestyle is None and the default marker is 'o',
though these can be overridden with keyword args. The cross
@@ -3059,7 +3064,7 @@
if usevlines=False, kwargs are passed onto Axes.plot
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.
+ The default value of None will return all ``(2*len(x)-1)`` lags.
See the respective function for documentation on valid kwargs
"""
Modified: trunk/matplotlib/lib/matplotlib/text.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/text.py 2008-05-23 20:32:56 UTC (rev
5245)
+++ trunk/matplotlib/lib/matplotlib/text.py 2008-05-23 21:53:01 UTC (rev
5246)
@@ -990,36 +990,47 @@
(see matplotlib.lines.Line2D) for the arrow that connects
annotation to the point. Valid keys are
- - width : the width of the arrow in points
- - frac : the fraction of the arrow length occupied by the head
- - headwidth : the width of the base of the arrow head in points
- - shrink: often times it is convenient to have the arrowtip
- and base a bit away from the text and point being
- annotated. If d is the distance between the text and
- annotated point, shrink will shorten the arrow so the tip
- and base are shink percent of the distance d away from the
- endpoints. ie, shrink=0.05 is 5%%
- - any key for matplotlib.patches.polygon
+ ========= ===========================================================
+ Key Description
+ ========= ===========================================================
+ width the width of the arrow in points
+ frac the fraction of the arrow length occupied by the head
+ headwidth the width of the base of the arrow head in points
+ shrink often times it is convenient to have the arrowtip
+ and base a bit away from the text and point being
+ annotated. If d is the distance between the text and
+ annotated point, shrink will shorten the arrow so the tip
+ and base are shink percent of the distance d away from the
+ endpoints. ie, shrink=0.05 is 5%%
+ ? any key for matplotlib.patches.polygon
+ ========= ===========================================================
xycoords and textcoords are strings that indicate the
coordinates of xy and xytext.
- 'figure points' : points from the lower left corner of the figure
- 'figure pixels' : pixels from the lower left corner of the figure
'figure fraction' : 0,0 is lower left of figure and
1,1 is upper, right
- 'axes points' : points from lower left corner of axes
- 'axes pixels' : pixels from lower left corner of axes
- 'axes fraction' : 0,1 is lower left of axes and 1,1 is upper right
- 'data' : use the coordinate system of the object being
annotated (default)
- 'offset points' : Specify an offset (in points) from the xy
value
- 'polar' : you can specify theta, r for the annotation,
even
- in cartesian plots. Note that if you
- are using a polar axes, you do not need
- to specify polar for the coordinate
- system since that is the native"data"
coordinate system.
+ ================= ===================================================
+ Property Description
+ ================= ===================================================
+ 'figure points' points from the lower left corner of the figure
+ 'figure pixels' pixels from the lower left corner of the figure
+ 'figure fraction' 0,0 is lower left of figure and 1,1 is upper, right
+ 'axes points' points from lower left corner of axes
+ 'axes pixels' pixels from lower left corner of axes
+ 'axes fraction' 0,1 is lower left of axes and 1,1 is upper right
+ 'data' use the coordinate system of the object being
+ annotated (default)
+ 'offset points' Specify an offset (in points) from the xy value
+ 'polar' you can specify theta, r for the annotation, even
+ in cartesian plots. Note that if you
+ are using a polar axes, you do not need
+ to specify polar for the coordinate
+ system since that is the native"data" coordinate
+ system.
+ ================= ===================================================
If a points or pixels option is specified, values will be
added to the left, bottom and if negative, values will be
- subtracted from the top, right. Eg,
+ subtracted from the top, right. Eg::
# 10 points to the right of the left border of the axes and
# 5 points below the top border
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2008.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
