More cleanup defaults in docstrings

Author: timhoffm

lib/matplotlib/_cm.py

@@ -86,16 +86,16 @@ def cubehelix(gamma=1.0, s=0.5, r=-1.5, h=1.0):
 
     Parameters
     ----------
-    gamma : float, optional, default: 1
+    gamma : float, default: 1
         Gamma factor emphasizing either low intensity values (gamma < 1), or
         high intensity values (gamma > 1).
-    s : float, optional, default: 0.5 (purple)
+    s : float, default: 0.5 (purple)
         The starting color.
-    r : float, optional, default: -1.5
+    r : float, default: -1.5
         The number of r, g, b rotations in color that are made from the start
         to the end of the color scheme.  The default of -1.5 corresponds to ->
         B -> G -> R -> B.
-    h : float, optional, default: 1
+    h : float, default: 1
         The hue, i.e. how saturated the colors are. If this parameter is zero
         then the color scheme is purely a greyscale.
     """

lib/matplotlib/axes/_axes.py

@@ -1771,7 +1771,7 @@ def loglog(self, *args, **kwargs):
 
         Parameters
         ----------
-        basex, basey : scalar, optional, default 10
+        basex, basey : float, default: 10
             Base of the x/y logarithm.
 
         subsx, subsy : sequence, optional
@@ -1780,7 +1780,7 @@ def loglog(self, *args, **kwargs):
             decades in the plot.
             See `.Axes.set_xscale` / `.Axes.set_yscale` for details.
 
-        nonposx, nonposy : {'mask', 'clip'}, optional, default 'mask'
+        nonposx, nonposy : {'mask', 'clip'}, default: 'mask'
             Non-positive values in x or y can be masked as invalid, or clipped
             to a very small positive number.
 
@@ -1825,15 +1825,15 @@ def semilogx(self, *args, **kwargs):
 
         Parameters
         ----------
-        basex : scalar, optional, default 10
+        basex : float, default: 10
             Base of the x logarithm.
 
         subsx : array-like, optional
             The location of the minor xticks. If *None*, reasonable locations
             are automatically chosen depending on the number of decades in the
             plot. See `.Axes.set_xscale` for details.
 
-        nonposx : {'mask', 'clip'}, optional, default 'mask'
+        nonposx : {'mask', 'clip'}, default: 'mask'
             Non-positive values in x can be masked as invalid, or clipped to a
             very small positive number.
 
@@ -1874,15 +1874,15 @@ def semilogy(self, *args, **kwargs):
 
         Parameters
         ----------
-        basey : scalar, optional, default 10
+        basey : float, default: 10
             Base of the y logarithm.
 
         subsy : array-like, optional
             The location of the minor yticks. If *None*, reasonable locations
             are automatically chosen depending on the number of decades in the
             plot. See `.Axes.set_yscale` for details.
 
-        nonposy : {'mask', 'clip'}, optional, default 'mask'
+        nonposy : {'mask', 'clip'}, default: 'mask'
             Non-positive values in y can be masked as invalid, or clipped to a
             very small positive number.
 

lib/matplotlib/axes/_base.py

@@ -1247,7 +1247,7 @@ def set_aspect(self, aspect, adjustable=None, anchor=None, share=False):
 
             See `.set_anchor` for further details.
 
-        share : bool, optional, default: False
+        share : bool, default: False
             If ``True``, apply the settings to all shared Axes.
 
         See Also
@@ -1309,7 +1309,7 @@ def set_adjustable(self, adjustable, share=False):
             If 'box', change the physical dimensions of the Axes.
             If 'datalim', change the ``x`` or ``y`` data limits.
 
-        share : bool, optional, default: False
+        share : bool, default: False
             If ``True``, apply the settings to all shared Axes.
 
         See Also
@@ -1443,7 +1443,7 @@ def set_anchor(self, anchor, share=False):
               | 'SW' | 'S'  | 'SE' |
               +------+------+------+
 
-        share : bool, optional, default: False
+        share : bool, default: False
             If ``True``, apply the settings to all shared Axes.
 
         See Also
@@ -1664,7 +1664,7 @@ def axis(self, *args, emit=True, **kwargs):
                      ``xmax-xmin == ymax-ymin``.
             ======== ==========================================================
 
-        emit : bool, optional, default *True*
+        emit : bool, default: True
             Whether observers are notified of the axis limit change.
             This option is passed on to `~.Axes.set_xlim` and
             `~.Axes.set_ylim`.
@@ -2092,7 +2092,7 @@ def update_datalim(self, xys, updatex=True, updatey=True):
             The points to include in the data limits Bbox. This can be either
             a list of (x, y) tuples or a Nx2 array.
 
-        updatex, updatey : bool, optional, default *True*
+        updatex, updatey : bool, default: True
             Whether to update the x/y limits.
         """
         xys = np.asarray(xys)
@@ -2370,12 +2370,12 @@ def autoscale(self, enable=True, axis='both', tight=None):
 
         Parameters
         ----------
-        enable : bool or None, optional, default: True
+        enable : bool or None, default: True
             True turns autoscaling on, False turns it off.
             None leaves the autoscaling state unchanged.
-        axis : {'both', 'x', 'y'}, optional, default: 'both'
+        axis : {'both', 'x', 'y'}, default: 'both'
             Which axis to operate on.
-        tight : bool or None, optional, default: None
+        tight : bool or None, default: None
             If True, first set the margins to zero.  Then, this argument is
             forwarded to `autoscale_view` (regardless of its value); see the
             description of its behavior there.
@@ -3174,14 +3174,14 @@ def set_xlim(self, left=None, right=None, emit=True, auto=False,
             The right xlim in data coordinates. Passing *None* leaves the
             limit unchanged.
 
-        emit : bool, optional, default: True
+        emit : bool, default: True
             Whether to notify observers of limit change.
 
-        auto : bool or None, optional, default: False
+        auto : bool or None, default: False
             Whether to turn on autoscaling of the x-axis. True turns on,
             False turns off, None leaves unchanged.
 
-        xmin, xmax : scalar, optional
+        xmin, xmax : float, optional
             They are equivalent to left and right respectively,
             and it is an error to pass both *xmin* and *left* or
             *xmax* and *right*.
@@ -3350,7 +3350,7 @@ def set_xticks(self, ticks, minor=False):
         ----------
         ticks : list
             List of x-axis tick locations.
-        minor : bool, optional, default: False
+        minor : bool, default: False
             If ``False`` sets major ticks, if ``True`` sets minor ticks.
         """
         ret = self.xaxis.set_ticks(ticks, minor=minor)
@@ -3555,10 +3555,10 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
             The top ylim in data coordinates. Passing *None* leaves the
             limit unchanged.
 
-        emit : bool, optional, default: True
+        emit : bool, default: True
             Whether to notify observers of limit change.
 
-        auto : bool or None, optional, default: False
+        auto : bool or None, default: False
             Whether to turn on autoscaling of the y-axis. *True* turns on,
             *False* turns off, *None* leaves unchanged.
 
@@ -3731,7 +3731,7 @@ def set_yticks(self, ticks, minor=False):
         ----------
         ticks : list
             List of y-axis tick locations
-        minor : bool, optional, default: False
+        minor : bool, default: False
             If ``False`` sets major ticks, if ``True`` sets minor ticks.
         """
         ret = self.yaxis.set_ticks(ticks, minor=minor)

lib/matplotlib/axes/_secondary_axes.py

@@ -170,7 +170,7 @@ def set_ticks(self, ticks, minor=False):
         ----------
         ticks : list
             List of x-axis tick locations.
-        minor : bool, optional, default: False
+        minor : bool, default: False
             If ``False`` sets major ticks, if ``True`` sets minor ticks.
         """
         ret = self._axis.set_ticks(ticks, minor=minor)
@@ -306,7 +306,7 @@ def set_xlabel(self, xlabel, fontdict=None, labelpad=None, **kwargs):
         xlabel : str
             The label text.
 
-        labelpad : scalar, optional, default: None
+        labelpad : float, default: ``self.xaxis.labelpad``
             Spacing in points between the label and the x-axis.
 
         Other Parameters
@@ -324,15 +324,15 @@ def set_xlabel(self, xlabel, fontdict=None, labelpad=None, **kwargs):
 
     def set_ylabel(self, ylabel, fontdict=None, labelpad=None, **kwargs):
         """
-        Set the label for the x-axis.
+        Set the label for the y-axis.
 
         Parameters
         ----------
         ylabel : str
             The label text.
 
-        labelpad : scalar, optional, default: None
-            Spacing in points between the label and the x-axis.
+        labelpad : scalar, default: ``self.yaxis.labelpad``
+            Spacing in points between the label and the y-axis.
 
         Other Parameters
         ----------------

lib/matplotlib/backend_bases.py

@@ -3170,7 +3170,7 @@ def add_tool(self, tool, group, position=-1):
             The tool to add, see `ToolManager.get_tool`.
         group : str
             The name of the group to add this tool to.
-        position : int, optional, default: -1
+        position : int, default: -1
             The position within the group to place this tool.
         """
         tool = self.toolmanager.get_tool(tool)

lib/matplotlib/collections.py

@@ -932,12 +932,11 @@ def legend_elements(self, prop="colors", num="auto",
 
         Parameters
         ----------
-        prop : string, optional, default *"colors"*
-            Can be *"colors"* or *"sizes"*. In case of *"colors"*, the legend
-            handles will show the different colors of the collection. In case
-            of "sizes", the legend will show the different sizes.
+        prop : {"colors", "sizes"}, default: "colors"
+            If "colors", the legend handles will show the different colors of
+            the collection. If "sizes", the legend will show the different
+            sizes.
         num : int, None, "auto" (default), array-like, or `~.ticker.Locator`,
-            optional
             Target number of elements to create.
             If None, use all unique elements of the mappable array. If an
             integer, target to use *num* elements in the normed range.

lib/matplotlib/colors.py

@@ -1602,10 +1602,10 @@ def __init__(self, azdeg=315, altdeg=45, hsv_min_val=0, hsv_max_val=1,
 
         Parameters
         ----------
-        azdeg : float, optional, default: 315 degrees (from the northwest)
+        azdeg : float, default: 315 degrees (from the northwest)
             The azimuth (0-360, degrees clockwise from North) of the light
             source.
-        altdeg : float, optional, default: 45 degrees
+        altdeg : float, default: 45 degrees
             The altitude (0-90, degrees up from horizontal) of the light
             source.
 

lib/matplotlib/contour.py

@@ -64,7 +64,7 @@ def clabel(self, levels=None, *,
             A list of level values, that should be labeled. The list must be
             a subset of ``cs.levels``. If not given, all levels are labeled.
 
-        fontsize : str or float, optional
+        fontsize : str or float, default: :rc:`font.size`
             Size in points or relative size e.g., 'smaller', 'x-large'.
             See `.Text.set_size` for accepted string values.
 
@@ -80,17 +80,17 @@ def clabel(self, levels=None, *,
             - If a tuple of colors (string, float, rgb, etc), different labels
               will be plotted in different colors in the order specified.
 
-        inline : bool, optional, default: True
+        inline : bool, default: True
             If ``True`` the underlying contour is removed where the label is
             placed.
 
-        inline_spacing : float, optional, default: 5
+        inline_spacing : float, default: 5
             Space in pixels to leave on each side of label when placing inline.
 
             This spacing will be exact for labels at locations where the
             contour is straight, less so for labels on curved contours.
 
-        fmt : str or dict, optional, default: '%1.3f'
+        fmt : str or dict, default: '%1.3f'
             A format string for the label.
 
             Alternatively, this can be a dictionary matching contour levels
@@ -114,11 +114,11 @@ def clabel(self, levels=None, *,
             Contour labels will be created as if mouse is clicked at each
             (x, y) position.
 
-        rightside_up : bool, optional, default: True
+        rightside_up : bool, default: True
             If ``True``, label rotations will always be plus
             or minus 90 degrees from level.
 
-        use_clabeltext : bool, optional, default: False
+        use_clabeltext : bool, default: False
             If ``True``, `.ClabelText` class (instead of `.Text`) is used to
             create labels. `ClabelText` recalculates rotation angles
             of texts during the drawing time, therefore this can be used if
@@ -461,10 +461,10 @@ def add_label_near(self, x, y, inline=True, inline_spacing=5,
         x, y : float
             The approximate location of the label.
 
-        inline : bool, optional, default: True
+        inline : bool, default: True
             If *True* remove the segment of the contour beneath the label.
 
-        inline_spacing : int, optional, default: 5
+        inline_spacing : int, default: 5
             Space in pixels to leave on each side of label when placing
             inline. This spacing will be exact for labels at locations where
             the contour is straight, less so for labels on curved contours.
@@ -1686,8 +1686,7 @@ def _initialize_x_y(self, z):
             are not given explicitly via *levels*.
             Defaults to `~.ticker.MaxNLocator`.
 
-        extend : {'neither', 'both', 'min', 'max'}, optional, default: \
-'neither'
+        extend : {'neither', 'both', 'min', 'max'}, default: 'neither'
             Determines the ``contourf``-coloring of values that are outside the
             *levels* range.
 

lib/matplotlib/figure.py

@@ -1027,7 +1027,7 @@ def add_artist(self, artist, clip=False):
             The artist to add to the figure. If the added artist has no
             transform previously set, its transform will be set to
             ``figure.transFigure``.
-        clip : bool, optional, default: False
+        clip : bool, default: False
             Whether the added artist should be clipped by the figure patch.
 
         Returns
@@ -1414,7 +1414,7 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
 
         Parameters
         ----------
-        nrows, ncols : int, optional, default: 1
+        nrows, ncols : int, default: 1
             Number of rows/columns of the subplot grid.
 
         sharex, sharey : bool or {'none', 'all', 'row', 'col'}, default: False
@@ -1432,7 +1432,7 @@ def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
             first column subplot are created. To later turn other subplots'
             ticklabels on, use `~matplotlib.axes.Axes.tick_params`.
 
-        squeeze : bool, optional, default: True
+        squeeze : bool, default: True
             - If True, extra dimensions are squeezed out from the returned
               array of Axes:
 
@@ -1841,12 +1841,13 @@ def text(self, x, y, s, fontdict=None, withdash=False, **kwargs):
         s : str
             The text string.
 
-        fontdict : dictionary, optional, default: None
-            A dictionary to override the default text properties. If fontdict
-            is None, the defaults are determined by your rc parameters. A
-            property in *kwargs* override the same property in fontdict.
+        fontdict : dict, optional
+            A dictionary to override the default text properties. If not given,
+            the defaults are determined by your rc parameters. Properties
+            passed as *kwargs* override the corresponding ones given in
+            *fontdict*.
 
-        withdash : boolean, optional, default: False
+        withdash : bool, default: False
             Creates a `~matplotlib.text.TextWithDash` instance instead of a
             `~matplotlib.text.Text` instance.
 
@@ -2298,19 +2299,19 @@ def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,
 
         Parameters
         ----------
-        n : int, optional, default: 1
+        n : int, default: 1
             Number of mouse clicks to accumulate. If negative, accumulate
             clicks until the input is terminated manually.
-        timeout : scalar, optional, default: 30
+        timeout : scalar, default: 30 seconds
             Number of seconds to wait before timing out. If zero or negative
             will never timeout.
-        show_clicks : bool, optional, default: True
+        show_clicks : bool, default: True
             If True, show a red cross at the location of each click.
-        mouse_add : {1, 2, 3, None}, optional, default: 1 (left click)
+        mouse_add : {1, 2, 3, None}, default: 1 (left click)
             Mouse button used to add points.
-        mouse_pop : {1, 2, 3, None}, optional, default: 3 (right click)
+        mouse_pop : {1, 2, 3, None}, default: 3 (right click)
             Mouse button used to remove the most recently added point.
-        mouse_stop : {1, 2, 3, None}, optional, default: 2 (middle click)
+        mouse_stop : {1, 2, 3, None}, default: 2 (middle click)
             Mouse button used to stop input.
 
         Returns