SF.net SVN: matplotlib:[5875] trunk/matplotlib/lib/matplotlib

[<jd...@us...>]

Revision: 5875
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5875&view=rev
Author:   jdh2358
Date:     2008-07-25 17:38:06 +0000 (Fri, 25 Jul 2008)

Log Message:
-----------
cleaned up a few rest doc warnings

Modified Paths:
--------------
    trunk/matplotlib/lib/matplotlib/cbook.py
    trunk/matplotlib/lib/matplotlib/figure.py

Modified: trunk/matplotlib/lib/matplotlib/cbook.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/cbook.py	2008-07-25 15:09:08 UTC (rev 5874)
+++ trunk/matplotlib/lib/matplotlib/cbook.py	2008-07-25 17:38:06 UTC (rev 5875)
@@ -1167,10 +1167,6 @@
     This is very inefficient linear interpolation meant to be used
     only for a small number of points in relatively non-intensive use
     cases.
-
-    Call signature::
-
-    yi = less_simple_linear_interpolation(x,y,xi)
     """
     if is_scalar(xi): xi = [xi]
 
@@ -1348,21 +1344,15 @@
 
     If you just want to see if the array has 1 axis, use X.ndim==1
 
-    Call signature::
-    isvector(X)
     """
     return np.prod(X.shape)==np.max(X.shape)
 
 def vector_lengths( X, P=2., axis=None ):
     """
     Finds the length of a set of vectors in n dimensions.  This is
-    like the mlab.norm function for vectors, but has the ability to
+    like the numpy norm function for vectors, but has the ability to
     work over a particular axis of the supplied array or matrix.
 
-    Call signature::
-
-    vector_lengths( X, P=2., axis=None )
-
     Computes (sum((x_i)^P))^(1/P) for each {x_i} being the elements of X along
     the given axis.  If *axis* is *None*, compute over all elements of X.
     """
@@ -1373,10 +1363,6 @@
     """
     Computes the distance between a set of successive points in N dimensions.
 
-    Call signature::
-
-    distances_along_curve(X)
-
     where X is an MxN array or matrix.  The distances between successive rows
     is computed.  Distance is the standard Euclidean distance.
     """
@@ -1387,10 +1373,7 @@
     """
     Computes the distance travelled along a polygonal curve in N dimensions.
 
-    Call signature::
 
-    path_length(X)
-
     where X is an MxN array or matrix.  Returns an array of length M consisting
     of the distance along the curve at each point (i.e., the rows of X).
     """
@@ -1403,9 +1386,6 @@
     presumably coordinates on a polygonal curve, in which case this function
     tests if that curve is closed.
 
-    Call signature::
-
-    is_closed_polygon(X)
     """
     return np.all(X[0] == X[-1])
 

Modified: trunk/matplotlib/lib/matplotlib/figure.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/figure.py	2008-07-25 15:09:08 UTC (rev 5874)
+++ trunk/matplotlib/lib/matplotlib/figure.py	2008-07-25 17:38:06 UTC (rev 5875)
@@ -846,9 +846,9 @@
 
     def text(self, x, y, s, *args, **kwargs):
         """
-        Call signature:
+        Call signature::
 
-        figtext(x, y, s, fontdict=None, **kwargs)
+          figtext(x, y, s, fontdict=None, **kwargs)
 
         Add text to figure at location *x*, *y* (relative 0-1
         coords). See :func:`~matplotlib.pyplot.text` for the meaning


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.