More docstrings cleanup.

anntzer · anntzer · commit b5e4f32e8a87 · 2019-12-11T14:01:12.000+01:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -2990,7 +2990,7 @@ def tick_params(self, axis='both', **kwargs):
 
         Examples
         --------
-        Usage ::
+        ::
 
             ax.tick_params(direction='out', length=6, width=2, colors='r',
                            grid_color='r', grid_alpha=0.5)
@@ -3818,8 +3818,8 @@ def xaxis_date(self, tz=None):
 
         Parameters
         ----------
-        tz : str or `tzinfo` instance, optional
-            Timezone.  Defaults to :rc:`timezone`.
+        tz : str or `tzinfo`, default: :rc:`timezone`
+            Timezone.
         """
         # should be enough to inform the unit conversion interface
         # dates are coming in
@@ -3831,8 +3831,8 @@ def yaxis_date(self, tz=None):
 
         Parameters
         ----------
-        tz : str or `tzinfo` instance, optional
-            Timezone.  Defaults to :rc:`timezone`.
+        tz : str or `tzinfo`, default: :rc:`timezone`
+            Timezone.
         """
         self.yaxis.axis_date(tz)
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2614,7 +2614,6 @@ class NavigationToolbar2:
     'button_press_event' and 'button_release_event'.  See
     :meth:`FigureCanvasBase.mpl_connect` for more information
 
-
     They must also define
 
       :meth:`save_figure`
diff --git a/lib/matplotlib/colorbar.py b/lib/matplotlib/colorbar.py
@@ -399,8 +399,8 @@ class ColorbarBase(_ColorbarMappableDummy):
     ----------
     ax : `~matplotlib.axes.Axes`
         The `~.axes.Axes` instance in which the colorbar is drawn.
-    cmap : `~matplotlib.colors.Colormap` or None
-        The colormap to use. If *None*, use :rc:`image.cmap`.
+    cmap : `~matplotlib.colors.Colormap`, default: :rc:`image.cmap`
+        The colormap to use.
     norm : `~matplotlib.colors.Normalize`
 
     alpha : float
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -1616,15 +1616,13 @@ def _initialize_x_y(self, z):
 
         Other Parameters
         ----------------
-        corner_mask : bool, optional
+        corner_mask : bool, default: :rc:`contour.corner_mask`
             Enable/disable corner masking, which only has an effect if *Z* is
             a masked array.  If ``False``, any quad touching a masked point is
             masked out.  If ``True``, only the triangular corners of quads
             nearest those points are always masked out, other triangular
             corners comprising three unmasked points are contoured as usual.
 
-            Defaults to :rc:`contour.corner_mask`.
-
         colors : color string or sequence of colors, optional
             The colors of the levels, i.e. the lines for `.contour` and the
             areas for `.contourf`.
@@ -1643,10 +1641,9 @@ def _initialize_x_y(self, z):
         alpha : float, optional
             The alpha blending value, between 0 (transparent) and 1 (opaque).
 
-        cmap : str or `.Colormap`, optional
+        cmap : str or `.Colormap`, default: :rc:`image.cmap`
             A `.Colormap` instance or registered colormap name. The colormap
             maps the level values to colors.
-            Defaults to :rc:`image.cmap`.
 
             If both *colors* and *cmap* are given, an error is raised.
 
@@ -1740,7 +1737,7 @@ def _initialize_x_y(self, z):
             however introduce rendering artifacts at chunk boundaries depending
             on the backend, the *antialiased* flag and value of *alpha*.
 
-        linewidths : float or sequence of float, optional
+        linewidths : float or sequence of float, default: :rc:`lines.linewidth`
             *Only applies to* `.contour`.
 
             The line width of the contour lines.
@@ -1750,8 +1747,6 @@ def _initialize_x_y(self, z):
             If a sequence, the levels in ascending order will be plotted with
             the linewidths in the order specified.
 
-            Defaults to :rc:`lines.linewidth`.
-
         linestyles : {*None*, 'solid', 'dashed', 'dashdot', 'dotted'}, optional
             *Only applies to* `.contour`.
 
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -837,14 +837,12 @@ class AutoDateFormatter(ticker.Formatter):
             1. / (MINUTES_PER_DAY): rcParams['date.autoformat.minute'],
             1. / (SEC_PER_DAY): rcParams['date.autoformat.second'],
             1. / (MUSECONDS_PER_DAY): rcParams['date.autoformat.microsecond'],
-            }
-
+        }
 
     The algorithm picks the key in the dictionary that is >= the
     current scale and uses that format string.  You can customize this
     dictionary by doing::
 
-
     >>> locator = AutoDateLocator()
     >>> formatter = AutoDateFormatter(locator)
     >>> formatter.scaled[1/(24.*60.)] = '%M:%S' # only show min and sec
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -677,12 +677,10 @@ def suptitle(self, t, **kwargs):
             The font weight of the text. See `.Text.set_weight` for possible
             values.
 
-
         Returns
         -------
-            text
-                The `.Text` instance of the title.
-
+        text
+            The `.Text` instance of the title.
 
         Other Parameters
         ----------------
@@ -695,7 +693,6 @@ def suptitle(self, t, **kwargs):
         **kwargs
             Additional kwargs are :class:`matplotlib.text.Text` properties.
 
-
         Examples
         --------
         >>> fig.suptitle('This is the figure title', fontsize=12)
@@ -776,20 +773,20 @@ def figimage(self, X, xo=0, yo=0, alpha=None, norm=None, cmap=None,
         alpha : None or float
             The alpha blending value.
 
-        norm : :class:`matplotlib.colors.Normalize`
+        norm : `matplotlib.colors.Normalize`
             A :class:`.Normalize` instance to map the luminance to the
             interval [0, 1].
 
-        cmap : str or :class:`matplotlib.colors.Colormap`
-            The colormap to use. Default: :rc:`image.cmap`.
+        cmap : str or `matplotlib.colors.Colormap`, default: :rc:`image.cmap`
+            The colormap to use.
 
         vmin, vmax : scalar
             If *norm* is not given, these values set the data limits for the
             colormap.
 
-        origin : {'upper', 'lower'}
+        origin : {'upper', 'lower'}, default: :rc:`image.origin`
             Indicates where the [0, 0] index of the array is in the upper left
-            or lower left corner of the axes. Defaults to :rc:`image.origin`.
+            or lower left corner of the axes.
 
         resize : bool
             If *True*, resize the figure to match the given image size.
@@ -805,22 +802,21 @@ def figimage(self, X, xo=0, yo=0, alpha=None, norm=None, cmap=None,
 
         Notes
         -----
-        figimage complements the axes image
-        (:meth:`~matplotlib.axes.Axes.imshow`) which will be resampled
-        to fit the current axes.  If you want a resampled image to
-        fill the entire figure, you can define an
-        :class:`~matplotlib.axes.Axes` with extent [0, 0, 1, 1].
-
+        figimage complements the axes image (`~matplotlib.axes.Axes.imshow`)
+        which will be resampled to fit the current axes.  If you want
+        a resampled image to fill the entire figure, you can define an
+        `~matplotlib.axes.Axes` with extent [0, 0, 1, 1].
 
-        Examples::
+        Examples
+        --------
+        ::
 
             f = plt.figure()
             nx = int(f.get_figwidth() * f.dpi)
             ny = int(f.get_figheight() * f.dpi)
             data = np.random.random((ny, nx))
             f.figimage(data)
             plt.show()
-
         """
         if resize:
             dpi = self.get_dpi()
@@ -2109,13 +2105,11 @@ def savefig(self, fname, *, transparent=None, **kwargs):
 
             Whether the image should be stored as a progressive JPEG file.
 
-        facecolor : color or None, optional
-            The facecolor of the figure; if *None*, defaults to
-            :rc:`savefig.facecolor`.
+        facecolor : color, default: :rc:`savefig.facecolor`
+            The facecolor of the figure.
 
-        edgecolor : color or None, optional
-            The edgecolor of the figure; if *None*, defaults to
-            :rc:`savefig.edgecolor`
+        edgecolor : color, default: :rc:`savefig.edgecolor`
+            The edgecolor of the figure.
 
         orientation : {'landscape', 'portrait'}
             Currently only supported by the postscript backend.
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -730,7 +730,6 @@ def axes(arg=None, **kwargs):
         The axis will have the same limits, ticks, and scale as the axis
         of the shared axes.
 
-
     label : str
         A label for the returned axes.
 
@@ -1114,27 +1113,19 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs):
 
     Parameters
     ----------
-    shape : sequence of 2 ints
-        Shape of grid in which to place axis.
-        First entry is number of rows, second entry is number of columns.
-
-    loc : sequence of 2 ints
-        Location to place axis within grid.
-        First entry is row number, second entry is column number.
-
+    shape : (int, int)
+        Number of rows and of columns of the grid in which to place axis.
+    loc : (int, int)
+        Row number and column number of the axis location within the grid.
     rowspan : int
         Number of rows for the axis to span to the right.
-
     colspan : int
         Number of columns for the axis to span downwards.
-
     fig : `Figure`, optional
         Figure to place axis in. Defaults to current figure.
-
     **kwargs
         Additional keyword arguments are handed to `add_subplot`.
 
-
     Notes
     -----
     The following call ::
@@ -1143,8 +1134,8 @@ def subplot2grid(shape, loc, rowspan=1, colspan=1, fig=None, **kwargs):
 
     is identical to ::
 
-        gridspec=GridSpec(shape[0], shape[1])
-        subplotspec=gridspec.new_subplotspec(loc, rowspan, colspan)
+        gridspec = GridSpec(shape[0], shape[1])
+        subplotspec = gridspec.new_subplotspec(loc, rowspan, colspan)
         subplot(subplotspec)
     """
 
@@ -1804,7 +1795,6 @@ def colormaps():
                         black-blue-white-red-black
       ================  =================================================
 
-
     Other miscellaneous schemes:
 
       ============= =======================================================
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
@@ -52,7 +52,6 @@ def stackplot(axes, x, *args,
     **kwargs
         All other keyword arguments are passed to `Axes.fill_between()`.
 
-
     Returns
     -------
     list : list of `.PolyCollection`
diff --git a/lib/mpl_toolkits/axes_grid1/inset_locator.py b/lib/mpl_toolkits/axes_grid1/inset_locator.py
@@ -549,7 +549,7 @@ def zoomed_inset_axes(parent_axes, zoom, loc='upper right',
         coordinates (i.e., "zoomed in"), while *zoom* < 1 will shrink the
         coordinates (i.e., "zoomed out").
 
-    loc : int or str, optional, default to 1
+    loc : int or str, optional, default: 'upper right'
         Location to place the inset axes. The valid locations are::
 
             'upper right'  : 1,
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -2459,18 +2459,16 @@ def quiver(self, *args,
         ----------
         X, Y, Z : array-like
             The x, y and z coordinates of the arrow locations (default is
-            tail of arrow; see *pivot* kwarg)
+            tail of arrow; see *pivot* kwarg).
 
         U, V, W : array-like
-            The x, y and z components of the arrow vectors
+            The x, y and z components of the arrow vectors.
 
-        length : float
-            The length of each quiver, default to 1.0, the unit is
-            the same with the axes
+        length : float, default: 1
+            The length of each quiver.
 
-        arrow_length_ratio : float
-            The ratio of the arrow head with respect to the quiver,
-            default to 0.3
+        arrow_length_ratio : float, default: 0.3
+            The ratio of the arrow head with respect to the quiver.
 
         pivot : {'tail', 'middle', 'tip'}, default: 'tail'
             The part of the arrow that is at the grid point; the arrow
