tweaks to backend driver list

jdh2358 · jdh2358 · commit 43f359014d72 · 2008-12-09T03:33:57.000Z
svn path=/trunk/matplotlib/; revision=6528
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+2008-12-08 Removed the prints in the set_*style commands.  Return the
+           list of pprinted strings instead
+
 2008-12-08 Some of the changes Michael made to improve the output of
            the property tables in the rest docs broke of made
            difficult to use some of the interactive doc helpers, eg
diff --git a/examples/tests/backend_driver.py b/examples/tests/backend_driver.py
@@ -25,7 +25,7 @@
 
 pylab_dir = os.path.join('..', 'pylab_examples')
 pylab_files = [
-    'two_scales.py',
+
 
     'accented_text.py',
     'alignment_test.py',
@@ -191,44 +191,40 @@
     'unicode_demo.py',
     'vertical_ticklabels.py',
     'vline_demo.py',
-    'webapp_demo.py',
     'xcorr_demo.py',
     'zorder_demo.py',
-
     ]
 
 
 api_dir = os.path.join('..', 'api')
 api_files = [
     'agg_oo.py',
     'barchart_demo.py',
+    'bbox_intersect.py',
     'collections_demo.py',
+    'color_cycle.py',
+    'colorbar_only.py',
     'custom_projection_example.py',
     'custom_scale_example.py',
     'date_demo.py',
     'date_index_formatter.py',
+    'donut_demo.py',
     'font_family_rc.py',
-    'font_file.py',
     'histogram_demo.py',
     'image_zcoord.py',
     'legend_demo.py',
     'line_with_text.py',
     'logo2.py',
     'mathtext_asarray.py',
     'patch_collection.py',
+    'path_patch_demo.py',
+    'quad_bezier.py',
     'scatter_piecharts.py',
     'span_regions.py',
+    'two_scales.py'
     'unicode_minus.py',
     'watermark_image.py',
     'watermark_text.py',
-
-    'bbox_intersect.py',
-    'colorbar_only.py',
-    'color_cycle.py',
-    'donut_demo.py',
-    'path_patch_demo.py',
-    'quad_bezier.py',
-    'two_scales.py'
 ]
 
 units_dir = os.path.join('..', 'units')
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -1494,19 +1494,19 @@ class BoxStyle(_Style):
     :class:`BoxStyle` is a container class which defines several
     boxstyle classes, which are used for :class:`FancyBoxPatch`.
 
-    A style object can be created as
+    A style object can be created as::
 
            BoxStyle.Round(pad=0.2)
 
-    or
+    or::
 
            BoxStyle("Round", pad=0.2)
 
-    or
+    or::
 
            BoxStyle("Round, pad=0.2")
 
-    Following boxstyle classes are defined.
+    The following boxstyle classes are defined.
 
     %(AvailableBoxstyles)s
 
@@ -2026,18 +2026,15 @@ def set_boxstyle(self, boxstyle=None, **kw):
 
         Old attrs simply are forgotten.
 
-        Without argument (or with *boxstyle* = None), it prints out
+        Without argument (or with *boxstyle* = None), it returns
         available box styles.
 
         ACCEPTS: [ %(AvailableBoxstyles)s ]
 
         """
 
         if boxstyle==None:
-            # print out available boxstyles and return.
-            print "Following box styles are available:"
-            print BoxStyle.pprint_styles()
-            return
+            return BoxStyle.pprint_styles()
 
         if isinstance(boxstyle, BoxStyle._Base):
             self._bbox_transmuter = boxstyle
@@ -2097,7 +2094,7 @@ def get_path(self):
         return _path
 
 
-    # Followong methods are borrowed from the Rectangle class.
+    # Following methods are borrowed from the Rectangle class.
 
     def get_x(self):
         "Return the left coord of the rectangle"
@@ -2183,19 +2180,19 @@ class ConnectionStyle(_Style):
     between two points. These are mainly used with
     :class:`FancyArrowPatch`.
 
-    A connectionstyle object can be either created as
+    A connectionstyle object can be either created as::
 
            ConnectionStyle.Arc3(rad=0.2)
 
-    or
+    or::
 
            ConnectionStyle("Arc3", rad=0.2)
 
-    or
+    or::
 
            ConnectionStyle("Arc3, rad=0.2")
 
-    Following classes are defined
+    The following classes are defined
 
     %(AvailableConnectorstyles)s
 
@@ -2205,11 +2202,13 @@ class ConnectionStyle(_Style):
 
         __call__(self, posA, posB, patchA=None, patchB=None, shrinkA=2., shrinkB=2.)
 
-    and it returns a :class:`Path` instance. *posA* and *posB are tuples
-    of x,y coordinates of the two points to be connected. *patchA* (or
-    $patchB*) is given, the returned path is clipped so that it start
-    (or end) from the boundary of the patch. The path is further
-    shrinked by *shrinkA* (or *shrinkB*) which is given in points.
+    and it returns a :class:`Path` instance. *posA* and *posB* are
+    tuples of x,y coordinates of the two points to be
+    connected. *patchA* (or *patchB*) is given, the returned path is
+    clipped so that it start (or end) from the boundary of the
+    patch. The path is further shrunk by *shrinkA* (or *shrinkB*)
+    which is given in points.  
+
     """
 
     _style_list = {}
@@ -2547,18 +2546,18 @@ class ArrowStyle(_Style):
     arrowstyle classes, which is used to create an arrow path along a
     given path. These are mainly used with :class:`FancyArrowPatch`.
 
-    A arrowstyle object can be either created as
+    A arrowstyle object can be either created as::
 
            ArrowStyle.Fancy(head_length=.4, head_width=.4, tail_width=.4)
-    or
+    or::
 
            ArrowStyle("Fancy", head_length=.4, head_width=.4, tail_width=.4)
 
-    or
+    or::
 
            ArrowStyle("Fancy, head_length=.4, head_width=.4, tail_width=.4")
 
-    Following classes are defined
+    The following classes are defined
 
     %(AvailableArrowstyles)s
 
@@ -3232,7 +3231,7 @@ def __init__(self, posA=None, posB=None,
         connected. It can be an instance of the ConnectionStyle class
         (matplotlib.patches.ConnectionStlye) or a string of the
         connectionstyle name, with optional comma-separated
-        attributes.  Following connection styles are available.
+        attributes.  The following connection styles are available.
 
         %(AvailableConnectorstyles)s
 
@@ -3241,7 +3240,7 @@ def __init__(self, posA=None, posB=None,
         drawn. It can be string of the available arrowstyle names,
         with optional comma-separated attributes, or one of the
         ArrowStyle instance. The optional attributes are meant to be
-        scaled with the *mutation_scale*. Following arrow styles are
+        scaled with the *mutation_scale*. The following arrow styles are
         available.
 
         %(AvailableArrowstyles)s
@@ -3334,14 +3333,12 @@ def set_connectionstyle(self, connectionstyle, **kw):
 
         Old attrs simply are forgotten.
 
-        Without argument (or with connectionstyle=None), it prints out
-        available styles.
+        Without argument (or with connectionstyle=None), return
+        available styles as a list of strings.
         """
 
         if connectionstyle==None:
-            # print out available styles and return.
-            print "Following styles are available:"
-            print ConnectionStyle.pprint_styles()
+            return ConnectionStyle.pprint_styles()
 
         if isinstance(connectionstyle, ConnectionStyle._Base):
             self._connector = connectionstyle
@@ -3372,14 +3369,12 @@ def set_arrowstyle(self, arrowstyle=None, **kw):
 
         Old attrs simply are forgotten.
 
-        Without argument (or with arrowstyle=None), it prints out
-        available box styles.
+        Without argument (or with arrowstyle=None), return 
+        available box styles as a list of strings.
         """
 
         if arrowstyle==None:
-            # print out available styles and return.
-            print "Following styles are available:"
-            print ArrowStyle.pprint_styles()
+            return ArrowStyle.pprint_styles()
 
         if isinstance(arrowstyle, ConnectionStyle._Base):
             self._arrow_transmuter = arrowstyle
