SF.net SVN: matplotlib: [5626] trunk/matplotlib

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

Revision: 5626
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5626&view=rev
Author:   jdh2358
Date:     2008-06-21 10:07:25 -0700 (Sat, 21 Jun 2008)

Log Message:
-----------
minor docstring cleanups

Modified Paths:
--------------
    trunk/matplotlib/MANIFEST.in
    trunk/matplotlib/doc/faq/installing_faq.rst
    trunk/matplotlib/lib/matplotlib/lines.py
    trunk/matplotlib/lib/matplotlib/patches.py

Modified: trunk/matplotlib/MANIFEST.in
===================================================================
--- trunk/matplotlib/MANIFEST.in	2008-06-21 13:35:30 UTC (rev 5625)
+++ trunk/matplotlib/MANIFEST.in	2008-06-21 17:07:25 UTC (rev 5626)
@@ -15,7 +15,6 @@
 include lib/matplotlib/mpl-data/fonts/afm/*
 recursive-include license LICENSE*
 recursive-include examples *
-recursive-include doc *
 recursive-include src  *.cpp *.c *.h
 recursive-include CXX  *.cxx *.hxx *.c *.h
 recursive-include agg24 *

Modified: trunk/matplotlib/doc/faq/installing_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/installing_faq.rst	2008-06-21 13:35:30 UTC (rev 5625)
+++ trunk/matplotlib/doc/faq/installing_faq.rst	2008-06-21 17:07:25 UTC (rev 5626)
@@ -104,7 +104,7 @@
 people use matplotlib interactively from the python shell and have
 plotting windows pop up when they type commands.  Some people embed
 matplotlib into graphical user interfaces like wxpython or pygtk to
-build rich applications.  Others use matplotlib in batch scripts, to
+build rich applications.  Others use matplotlib in batch scripts to
 generate postscript images from some numerical simulations, and still
 others in web application servers to dynamically serve up graphs.
 

Modified: trunk/matplotlib/lib/matplotlib/lines.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/lines.py	2008-06-21 13:35:30 UTC (rev 5625)
+++ trunk/matplotlib/lib/matplotlib/lines.py	2008-06-21 17:07:25 UTC (rev 5626)
@@ -53,6 +53,7 @@
 
       y.filled()[ii[1,0]:ii[1,1]]
       # returns np.array [3,4,]
+
     '''
     m = np.concatenate(((1,), mask, (1,)))
     indices = np.arange(len(mask) + 1)

Modified: trunk/matplotlib/lib/matplotlib/patches.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/patches.py	2008-06-21 13:35:30 UTC (rev 5625)
+++ trunk/matplotlib/lib/matplotlib/patches.py	2008-06-21 17:07:25 UTC (rev 5626)
@@ -221,9 +221,10 @@
 
         CURRENT LIMITATIONS:
 
-          1. Hatching is supported in the PostScript backend only.
+        1. Hatching is supported in the PostScript backend only.
 
-          2. Hatching is done with solid black lines of width 0.
+        2. Hatching is done with solid black lines of width 0.
+
         """
         self._hatch = h
 
@@ -345,6 +346,7 @@
 
     def __init__(self, xy, width, height, **kwargs):
         """
+
         *fill* is a boolean indicating whether to fill the rectangle
 
         Valid kwargs are:
@@ -460,6 +462,8 @@
     def __init__(self, xy, numVertices, radius=5, orientation=0,
                  **kwargs):
         """
+        Constructor arguments:
+
         *xy*
           A length 2 tuple (*x*, *y*) of the center.
 
@@ -685,19 +689,21 @@
         head_width=None, head_length=None, shape='full', overhang=0, \
         head_starts_at_zero=False,**kwargs):
         """
-        *length_includes_head*:
-           *True* if head is counted in calculating the length.
+        Constructor arguments
 
-        *shape*: ['full', 'left', 'right']
+            *length_includes_head*:
+               *True* if head is counted in calculating the length.
 
-        *overhang*:
-          distance that the arrow is swept back (0 overhang means
-          triangular shape).
+            *shape*: ['full', 'left', 'right']
 
-        *head_starts_at_zero*:
-          If *True*, the head starts being drawn at coordinate 0
-          instead of ending at coordinate 0.
+            *overhang*:
+              distance that the arrow is swept back (0 overhang means
+              triangular shape).
 
+            *head_starts_at_zero*:
+              If *True*, the head starts being drawn at coordinate 0
+              instead of ending at coordinate 0.
+
         Valid kwargs are:
         %(Patch)s
 
@@ -761,6 +767,8 @@
 
     def __init__(self, figure, xytip, xybase, width=4, frac=0.1, headwidth=12, **kwargs):
         """
+        Constructor arguments:
+
         *xytip*
           (*x*, *y*) location of arrow tip
 
@@ -972,6 +980,8 @@
 
     def __init__(self, xy, width, height, angle=0.0, theta1=0.0, theta2=360.0, **kwargs):
         """
+        The following args are supported:
+
         *xy*
           center of ellipse
 


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