SF.net SVN: matplotlib:[6307] trunk/matplotlib/lib/matplotlib/axes.py

[<ry...@us...>]

Revision: 6307
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6307&view=rev
Author:   ryanmay
Date:     2008-10-23 15:42:25 +0000 (Thu, 23 Oct 2008)

Log Message:
-----------
Tweak barbs docstring to point to the appropriate example script.

Modified Paths:
--------------
    trunk/matplotlib/lib/matplotlib/axes.py

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008-10-23 15:29:50 UTC (rev 6306)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008-10-23 15:42:25 UTC (rev 6307)
@@ -5356,13 +5356,19 @@
     quiver.__doc__ = mquiver.Quiver.quiver_doc
 
     def barbs(self, *args, **kw):
+        """
+        %s
+        **Example:**
+
+        .. plot:: mpl_examples/pylab_examples/barb_demo.py
+        """
         if not self._hold: self.cla()
         b = mquiver.Barbs(self, *args, **kw)
         self.add_collection(b)
         self.update_datalim(b.get_offsets())
         self.autoscale_view()
         return b
-    barbs.__doc__ = mquiver.Barbs.barbs_doc
+    barbs.__doc__ = cbook.dedent(barbs.__doc__) % mquiver.Barbs.barbs_doc
 
     def fill(self, *args, **kwargs):
         """


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