Fix a bunch of warnings in the documentation build

mdboom · mdboom · commit 50381be1e93a · 2012-05-23T10:26:06.000-04:00
diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst
@@ -529,10 +529,12 @@ important for complex figures that take some time to draw.
 you're all done issuing commands and you want to draw the figure now.
 
 .. note::
-    :func:`~matplotlib.pyplot.show` should typically only be called
-    at most once per script and it should be the last line of your script.
-    At that point, the GUI takes control of the interpreter.  If you want
-    to force a figure draw, use :func:`~matplotlib.pyplot.draw` instead.
+
+    :func:`~matplotlib.pyplot.show` should typically only be called at
+    most once per script and it should be the last line of your
+    script.  At that point, the GUI takes control of the interpreter.
+    If you want to force a figure draw, use
+    :func:`~matplotlib.pyplot.draw` instead.
 
 Many users are frustrated by ``show`` because they want it to be a
 blocking call that raises the figure, pauses the script until they
@@ -778,4 +780,3 @@ Engineering, Vol. 9, No. 3. (2007), pp. 90-95 (see `citeulike <http://www.citeul
                       development, interactive scripting, and publication-quality image
                       generation across user interfaces and operating systems.},
 	  Bdsk-Url-1 = {http://gateway.isiknowledge.com/gateway/Gateway.cgi?GWVersion=2&SrcAuth=Alerting&SrcApp=Alerting&DestApp=WOS&DestLinkType=FullRecord;KeyUT=000245668100019}}
-
diff --git a/examples/api/logo2.py b/examples/api/logo2.py
@@ -47,7 +47,7 @@ def add_matplotlib_text(ax):
                ha='right', va='center', alpha=1.0, transform=ax.transAxes)
 
 def add_polar_bar():
-    ax = fig.add_axes([0.025, 0.075, 0.2, 0.85], polar=True, resolution=50)
+    ax = fig.add_axes([0.025, 0.075, 0.2, 0.85], polar=True)
 
 
     ax.axesPatch.set_alpha(axalpha)
@@ -79,5 +79,3 @@ def add_polar_bar():
     add_polar_bar()
     add_matplotlib_text(main_axes)
     plt.show()
-
-
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -2728,7 +2728,7 @@ def set_yticks(self, ticks, minor=False):
 
     def get_ymajorticklabels(self):
         """
-        Get the major y tick labels as a list of 
+        Get the major y tick labels as a list of
         :class:`~matplotlib.text.Text` instances.
         """
         return cbook.silent_list('Text yticklabel',
@@ -7532,11 +7532,13 @@ def hist(x, bins=10, range=None, normed=False, weights=None,
               pdf, bins, patches = ax.hist(...)
               print np.sum(pdf * np.diff(bins))
 
-            .. Note:: Until numpy release 1.5, the underlying numpy
-                      histogram function was incorrect with *normed*=*True*
-                      if bin sizes were unequal.  MPL inherited that
-                      error.  It is now corrected within MPL when using
-                      earlier numpy versions
+            .. note::
+
+                Until numpy release 1.5, the underlying numpy
+                histogram function was incorrect with *normed*=*True*
+                if bin sizes were unequal.  MPL inherited that
+                error.  It is now corrected within MPL when using
+                earlier numpy versions
 
           *weights*:
             An array of weights, of the same shape as *x*.  Each value in
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -936,6 +936,7 @@ def get_split_ind(seq, N):
 
         len(' '.join(seq[:ind])<=N
 
+    .
     """
 
     sLen = 0
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -1490,6 +1490,7 @@ def from_values(a, b, c, d, e, f):
           b d f
           0 0 1
 
+        .
         """
         return Affine2D(
             np.array([a, c, e, b, d, f, 0.0, 0.0, 1.0], np.float_)
@@ -1503,6 +1504,7 @@ def get_matrix(self):
           b d f
           0 0 1
 
+        .
         """
         self._invalid = 0
         return self._mtx
@@ -1515,6 +1517,7 @@ def set_matrix(self, mtx):
           b d f
           0 0 1
 
+        .
         """
         self._mtx = mtx
         self.invalidate()
@@ -2333,4 +2336,3 @@ def offset_copy(trans, fig=None, x=0.0, y=0.0, units='inches'):
     elif not units == 'inches':
         raise ValueError('units must be dots, points, or inches')
     return trans + ScaledTranslation(x, y, fig.dpi_scale_trans)
-
diff --git a/lib/mpl_toolkits/axes_grid1/axes_divider.py b/lib/mpl_toolkits/axes_grid1/axes_divider.py
@@ -153,6 +153,8 @@ def set_horizontal(self, h):
         :param horizontal: list of sizes
                     (:mod:`~mpl_toolkits.axes_grid.axes_size`)
                     for horizontal division
+
+        .
         """
         self._horizontal = h
 
@@ -166,6 +168,8 @@ def set_vertical(self, v):
         :param horizontal: list of sizes
                     (:mod:`~mpl_toolkits.axes_grid.axes_size`)
                     for horizontal division
+
+        .
         """
         self._vertical = v
 
@@ -276,7 +280,7 @@ def append_size(self, position, size):
             raise ValueError("the position must be one of left, right, bottom, or top")
 
 
-    def add_auto_adjustable_area(self, 
+    def add_auto_adjustable_area(self,
                                  use_axes, pad=0.1,
                                  adjust_dirs=["left", "right", "bottom", "top"],
                                  ):
@@ -339,7 +343,7 @@ def get_subplotspec(self):
             return None
 
 
-            
+
 from matplotlib.gridspec import SubplotSpec, GridSpec
 
 class SubplotDivider(Divider):
@@ -919,10 +923,10 @@ def make_axes_locatable(axes):
 
     return divider
 
-def make_axes_area_auto_adjustable(ax, 
+def make_axes_area_auto_adjustable(ax,
                                    use_axes=None, pad=0.1,
                                    adjust_dirs=["left", "right", "bottom", "top"]):
-    
+
     divider = make_axes_locatable(ax)
 
     if use_axes is None:
@@ -934,5 +938,3 @@ def make_axes_area_auto_adjustable(ax,
 #from matplotlib.axes import Axes
 from mpl_axes import Axes
 LocatableAxes = locatable_axes_factory(Axes)
-
-
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -84,7 +84,7 @@ def __init__(self, fig, rect=None, *args, **kwargs):
 
         # func used to format z -- fall back on major formatters
         self.fmt_zdata = None
-        
+
         if zscale is not None :
             self.set_zscale(zscale)
 
@@ -608,10 +608,10 @@ def set_zticks(self, *args, **kwargs):
         .. versionadded:: 1.1.0
         """
         return self.zaxis.set_ticks(*args, **kwargs)
-        
+
     def get_zticks(self, minor=False):
         """
-        Return the z ticks as a list of locations  
+        Return the z ticks as a list of locations
         See :meth:`matplotlib.axes.Axes.get_yticks` for more details.
 
         .. note::
@@ -633,7 +633,7 @@ def get_zmajorticklabels(self) :
     def get_zminorticklabels(self) :
         """
         Get the ztick labels as a list of Text instances
-        
+
         .. note::
             Minor ticks are not supported. This function was added
             only for completeness.
@@ -1044,6 +1044,7 @@ def grid(self, b=True, **kwargs):
         Set / unset 3D grid.
 
         .. note::
+
             Currently, this function does not behave the same as
             :meth:`matplotlib.axes.Axes.grid`, but it is intended to
             eventually support that behavior.
@@ -1359,7 +1360,7 @@ def plot_surface(self, X, Y, Z, *args, **kwargs):
         # then an exception is automatically thrown.
         X.shape = (rows, cols)
         Y.shape = (rows, cols)
-        
+
         rstride = kwargs.pop('rstride', 10)
         cstride = kwargs.pop('cstride', 10)
 
@@ -1395,7 +1396,7 @@ def plot_surface(self, X, Y, Z, *args, **kwargs):
         #colset contains the data for coloring: either average z or the facecolor
         colset = []
         for rs in xrange(0, rows-1, rstride):
-            for cs in xrange(0, cols-1, cstride):  
+            for cs in xrange(0, cols-1, cstride):
                 ps = []
                 for a in (X, Y, Z) :
                     ztop = a[rs,cs:min(cols, cs+cstride+1)]
@@ -2075,7 +2076,7 @@ def get_test_data(delta=0.05):
 
 
 ########################################################
-# Register Axes3D as a 'projection' object available 
+# Register Axes3D as a 'projection' object available
 # for use just like any other axes
 ########################################################
 import matplotlib.projections as proj
