SF.net SVN: matplotlib:[6104] trunk/matplotlib/lib/matplotlib/colorbar.py

[<ef...@us...>]

Revision: 6104
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6104&view=rev
Author:   efiring
Date:     2008-09-18 00:49:15 +0000 (Thu, 18 Sep 2008)

Log Message:
-----------
More colorbar docstring improvements.

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

Modified: trunk/matplotlib/lib/matplotlib/colorbar.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/colorbar.py	2008-09-17 22:19:20 UTC (rev 6103)
+++ trunk/matplotlib/lib/matplotlib/colorbar.py	2008-09-18 00:49:15 UTC (rev 6104)
@@ -104,11 +104,11 @@
 arguments:
 
   *mappable*
-    the :class:`matplotlib.image.Image`,
-    :class:`matplotlib.contour.ContourSet`, etc. to
+    the :class:`~matplotlib.image.Image`,
+    :class:`~matplotlib.contour.ContourSet`, etc. to
     which the colorbar applies; this argument is mandatory for the
-    :meth:`matplotlib.figure.Figure.colorbar` method but optional for the
-    :func:`matplotlib.pyplot.colorbar` function, which sets the
+    :meth:`~matplotlib.figure.Figure.colorbar` method but optional for the
+    :func:`~matplotlib.pyplot.colorbar` function, which sets the
     default to the current image.
 
 keyword arguments:
@@ -141,9 +141,10 @@
 this case, do not use any of the axes properties kwargs.
 
 returns:
-    :class:`Colorbar` instance; see also its base class,
-    :class:`ColorbarBase`.  Call the :meth:`set_label` method
-    to label the colorbar
+    :class:`~matplotlib.colorbar.Colorbar` instance; see also its base class,
+    :class:`~matplotlib.colorbar.ColorbarBase`.  Call the
+    :meth:`~matplotlib.colorbar.ColorbarBase.set_label` method
+    to label the colorbar.
 
 ''' % (make_axes_kw_doc, colormap_kw_doc)
 


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