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

[<md...@us...>]

Revision: 6364
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6364&view=rev
Author:   mdboom
Date:     2008-11-05 15:15:10 +0000 (Wed, 05 Nov 2008)

Log Message:
-----------
Minor docstring fix.

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

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2008-11-05 14:43:29 UTC (rev 6363)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2008-11-05 15:15:10 UTC (rev 6364)
@@ -6931,23 +6931,23 @@
 
 class SubplotBase:
     """
-    Base class for subplots, which are Axes instances with additional
-    methods to facilitate generating and manipulating a set of Axes
-    within a figure.
+    Base class for subplots, which are :class:`Axes` instances with
+    additional methods to facilitate generating and manipulating a set
+    of :class:`Axes` within a figure.
     """
 
     def __init__(self, fig, *args, **kwargs):
         """
-        fig is a figure instance
+        *fig* is a :class:`matplotlib.figure.Figure` instance.
 
-        args is numRows, numCols, plotNum
-        where the array of subplots in the figure has dimensions
-        numRows, numCols, and where plotNum is the number of the
-        subplot being created.  plotNum starts at 1 in the upper
-        right corner and increases to the right.
+        *args* is the tuple (*numRows*, *numCols*, *plotNum*), where
+        the array of subplots in the figure has dimensions *numRows*,
+        *numCols*, and where *plotNum* is the number of the subplot
+        being created.  *plotNum* starts at 1 in the upper right
+        corner and increases to the right.
 
-        If numRows<=numCols<=plotNum<10, args can be the decimal
-        integer numRows*100 + numCols*10 + plotNum.
+        If *numRows* <= *numCols* <= *plotNum* < 10, *args* can be the
+        decimal integer *numRows* * 100 + *numCols* * 10 + *plotNum*.
         """
 
         self.figure = fig
@@ -6982,7 +6982,7 @@
 
     # COVERAGE NOTE: Never used internally or from examples
     def change_geometry(self, numrows, numcols, num):
-        'change subplot geometry, eg from 1,1,1 to 2,2,3'
+        'change subplot geometry, eg. from 1,1,1 to 2,2,3'
         self._rows = numrows
         self._cols = numcols
         self._num = num-1


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