Lots of minor changes to docs to reduce Sphinx warnings.

mdboom · mdboom · commit 6b119106656e · 2011-03-29T08:50:11.000-04:00
diff --git a/doc/users/legend_guide.rst b/doc/users/legend_guide.rst
@@ -244,7 +244,7 @@ Let's consider the following sample code, ::
 
   legend([p_1, p_2,..., p_i, ...], ["Test 1", "Test 2", ..., "Test i",...])
 
-For each *p_i*, matplotlib 
+For each *p_i*, matplotlib
 
   1. check if *p_i* itself is in the handler_map
   2. if not, iterate over type(p_i).mro() until a matching key is found in the handler_map
@@ -279,8 +279,8 @@ In the above example, only *p1* will be handled by *my_handler*, while
 others will be handled by default handlers.
 
 The curent default handler_map has handlers for errobar and bar
-plots. Also, it includes an entry for ��tuple�� which is mapped to
-*HandlerTuple*. It simply overplots all the handles for items in the
+plots. Also, it includes an entry for `tuple` which is mapped to
+`HandlerTuple`. It simply overplots all the handles for items in the
 given tuple. For example,
 
 
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -3861,14 +3861,14 @@ def plot_date(self, x, y, fmt='bo', tz=None, xdate=True, ydate=False,
 
         .. seealso::
 
-            :mod:`~matplotlib.dates`
-                for helper functions
+           :mod:`~matplotlib.dates`
+              for helper functions
 
-            :func:`~matplotlib.dates.date2num`,
-            :func:`~matplotlib.dates.num2date` and
-            :func:`~matplotlib.dates.drange`
-                for help on creating the required floating point
-                dates.
+           :func:`~matplotlib.dates.date2num`,
+           :func:`~matplotlib.dates.num2date` and
+           :func:`~matplotlib.dates.drange`
+              for help on creating the required floating point
+              dates.
         """
 
         if not self._hold: self.cla()
@@ -4210,14 +4210,14 @@ def _get_legend_handles(self, legend_handler_map=None):
         if legend_handler_map is not None:
             handler_map = handler_map.copy()
             handler_map.update(legend_handler_map)
-        
+
         handles = []
         for h in handles_original:
             if h.get_label() == "_nolegend_": #.startswith('_'):
                 continue
             if mlegend.Legend.get_legend_handler(handler_map, h):
                 handles.append(h)
-                
+
         return handles
 
 
@@ -5328,7 +5328,7 @@ def xywhere(xs, ys, mask):
                                                has_yerr=(yerr is not None),
                                                label=label)
         self.containers.append(errorbar_container)
-        
+
         return errorbar_container # (l0, caplines, barcols)
 
     def boxplot(self, x, notch=0, sym='b+', vert=1, whis=1.5,
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -916,28 +916,42 @@ class TimerBase(object):
     event loops.
 
     Mandatory functions that must be implemented:
-    * _timer_start: Contains backend-specific code for starting the timer
-    * _timer_stop: Contains backend-specific code for stopping the timer
+
+        * `_timer_start`: Contains backend-specific code for starting
+          the timer
+
+        * `_timer_stop`: Contains backend-specific code for stopping
+          the timer
 
     Optional overrides:
-    * _timer_set_single_shot: Code for setting the timer to single shot
-        operating mode, if supported by the timer object. If not, the Timer
-        class itself will store the flag and the _on_timer method should
-        be overridden to support such behavior.
-    * _timer_set_interval: Code for setting the interval on the timer, if
-        there is a method for doing so on the timer object.
-    * _on_timer: This is the internal function that any timer object should
-        call, which will handle the task of running all callbacks that have
-        been set.
+
+        * `_timer_set_single_shot`: Code for setting the timer to
+          single shot operating mode, if supported by the timer
+          object. If not, the `Timer` class itself will store the flag
+          and the `_on_timer` method should be overridden to support
+          such behavior.
+
+        * `_timer_set_interval`: Code for setting the interval on the
+          timer, if there is a method for doing so on the timer
+          object.
+
+        * `_on_timer`: This is the internal function that any timer
+          object should call, which will handle the task of running
+          all callbacks that have been set.
 
     Attributes:
-    * interval: The time between timer events in milliseconds. Default
-        is 1000 ms.
-    * single_shot: Boolean flag indicating whether this timer should
-        operate as single shot (run once and then stop). Defaults to False.
-    * callbacks: Stores list of (func, args) tuples that will be called
-        upon timer events. This list can be manipulated directly, or the
-        functions add_callback and remove_callback can be used.
+
+        * `interval`: The time between timer events in
+          milliseconds. Default is 1000 ms.
+
+        * `single_shot`: Boolean flag indicating whether this timer
+          should operate as single shot (run once and then
+          stop). Defaults to `False`.
+
+        * `callbacks`: Stores list of (func, args) tuples that will be
+          called upon timer events. This list can be manipulated
+          directly, or the functions `add_callback` and
+          `remove_callback` can be used.
     '''
     def __init__(self, interval=None, callbacks=None):
         #Initialize empty callbacks list and setup default settings if necssary
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -956,14 +956,15 @@ def __init__(self, widths, heights, angles, units='points', **kwargs):
             angles of first axes, degrees CCW from the X-axis
 
         *units*: ['points' | 'inches' | 'dots' | 'width' | 'height'
-                        | 'x' | 'y' | 'xy']
-            units in which majors and minors are given; 'width' and 'height'
-            refer to the dimensions of the axes, while 'x' and 'y'
-            refer to the *offsets* data units. 'xy' differs from all
-            others in that the angle as plotted varies with the
-            aspect ratio, and equals the specified angle only when
-            the aspect ratio is unity.  Hence it behaves the same
-            as the :class:`~matplotlib.patches.Ellipse` with
+        | 'x' | 'y' | 'xy']
+
+            units in which majors and minors are given; 'width' and
+            'height' refer to the dimensions of the axes, while 'x'
+            and 'y' refer to the *offsets* data units. 'xy' differs
+            from all others in that the angle as plotted varies with
+            the aspect ratio, and equals the specified angle only when
+            the aspect ratio is unity.  Hence it behaves the same as
+            the :class:`~matplotlib.patches.Ellipse` with
             axes.transData as its transform.
 
         Additional kwargs inherited from the base :class:`Collection`:
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -759,44 +759,44 @@ def set_marker(self, marker):
         """
         Set the line marker
 
-        ========== ==========================
-        marker     description
-        ========== ==========================
-        ``'.'``    point
-        ``','``    pixel
-        ``'o'``    circle
-        ``'v'``    triangle_down
-        ``'^'``    triangle_up
-        ``'<'``    triangle_left
-        ``'>'``    triangle_right
-        ``'1'``    tri_down
-        ``'2'``    tri_up
-        ``'3'``    tri_left
-        ``'4'``    tri_right
-        ``'s'``    square
-        ``'p'``    pentagon
-        ``'*'``    star
-        ``'h'``    hexagon1
-        ``'H'``    hexagon2
-        ``'+'``    plus
-        ``'x'``    x
-        ``'D'``    diamond
-        ``'d'``    thin_diamond
-        ``'|'``    vline
-        ``'_'``    hline
-        TICKLEFT   tickleft
-        TICKRIGHT  tickright
-        TICKUP     tickup
-        TICKDOWN   tickdown
-        CARETLEFT  caretleft
-        CARETRIGHT caretright
-        CARETUP    caretup
-        CARETDOWN  caretdown
-        ``'None'`` nothing
-        ``' '``    nothing
-        ``''``     nothing
-        '$...$'    render the string using mathtext
-        ========== ==========================
+        =========== ===================================
+        marker      description
+        =========== ===================================
+        ``'.'``     point
+        ``','``     pixel
+        ``'o'``     circle
+        ``'v'``     triangle_down
+        ``'^'``     triangle_up
+        ``'<'``     triangle_left
+        ``'>'``     triangle_right
+        ``'1'``     tri_down
+        ``'2'``     tri_up
+        ``'3'``     tri_left
+        ``'4'``     tri_right
+        ``'s'``     square
+        ``'p'``     pentagon
+        ``'*'``     star
+        ``'h'``     hexagon1
+        ``'H'``     hexagon2
+        ``'+'``     plus
+        ``'x'``     x
+        ``'D'``     diamond
+        ``'d'``     thin_diamond
+        ``'|'``     vline
+        ``'_'``     hline
+        TICKLEFT    tickleft
+        TICKRIGHT   tickright
+        TICKUP      tickup
+        TICKDOWN    tickdown
+        CARETLEFT   caretleft
+        CARETRIGHT  caretright
+        CARETUP     caretup
+        CARETDOWN   caretdown
+        ``'None'``  nothing
+        ``' '``     nothing
+        ``''``      nothing
+        ``'$...$'`` render the string using mathtext
+        =========== ===================================
 
 
 
@@ -808,7 +808,7 @@ def set_marker(self, marker):
                  | ``'x'`` | ``'|'``
                  | TICKUP | TICKDOWN | TICKLEFT | TICKRIGHT
                  | CARETUP | CARETDOWN | CARETLEFT | CARETRIGHT
-                 | ``'None'`` | ``' '`` | ``''`` | '$...$']
+                 | ``'None'`` | ``' '`` | ``''`` | ``'$...$'`` ]
 
         """
         if marker in self._markers:
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -2137,7 +2137,7 @@ def set_boxstyle(self, boxstyle=None, **kw):
         Without argument (or with *boxstyle* = None), it returns
         available box styles.
 
-        ACCEPTS: [ %(AvailableBoxstyles)s ]
+        ACCEPTS: %(AvailableBoxstyles)s
 
         """
 
@@ -3816,7 +3816,7 @@ def get_path(self):
         """
         return the path of the arrow in the data coordinate. Use
         get_path_in_displaycoord() method to retrieve the arrow path
-        in the disaply coord.  
+        in the display coord.
         """
         _path, fillable = self.get_path_in_displaycoord()
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -694,13 +694,17 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
       the first column of plots will have visible set to False
 
     squeeze : bool
-
       If True, extra dimensions are squeezed out from the returned axis object:
-        - if only one subplot is constructed (nrows=ncols=1), the resulting
-        single Axis object is returned as a scalar.
-        - for Nx1 or 1xN subplots, the returned object is a 1-d numpy object
-        array of Axis objects are returned as numpy 1-d arrays.
-        - for NxM subplots with N>1 and M>1 are returned as a 2d array.
+
+        - if only one subplot is constructed (nrows=ncols=1), the
+          resulting single Axis object is returned as a scalar.
+
+        - for Nx1 or 1xN subplots, the returned object is a 1-d numpy
+          object array of Axis objects are returned as numpy 1-d
+          arrays.
+
+        - for NxM subplots with N>1 and M>1 are returned as a 2d
+          array.
 
       If False, no squeezing at all is done: the returned axis object is always
       a 2-d array contaning Axis instances, even if it ends up being 1x1.
@@ -716,10 +720,13 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
     Returns:
 
     fig, ax : tuple
+
       - fig is the Matplotlib Figure object
-      - ax can be either a single axis object or an array of axis objects if
-      more than one supblot was created.  The dimensions of the resulting array
-      can be controlled with the squeeze keyword, see above.
+
+      - ax can be either a single axis object or an array of axis
+        objects if more than one supblot was created.  The dimensions
+        of the resulting array can be controlled with the squeeze
+        keyword, see above.
 
     **Examples:**
 
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -1506,6 +1506,7 @@ def get_matrix(self):
           a c e
           b d f
           0 0 1
+
         """
         self._invalid = 0
         return self._mtx
