Merge pull request #18844 from timhoffm/doc-fmt

jklymak · web-flow · commit 61a13c1b971f · 2020-10-29T20:43:40.000-07:00
Fix sphinx formatting issues
diff --git a/lib/matplotlib/_layoutgrid.py b/lib/matplotlib/_layoutgrid.py
@@ -285,7 +285,7 @@ def edit_margin_min(self, todo, size, cell=0):
             existing minimum it updates the margin size. Fraction of
             figure size.
 
-        cell: int
+        cell : int
             Cell column or row to edit.
         """
 
@@ -315,11 +315,11 @@ def edit_all_margins_min(self, todo, size):
 
         Parameters
         ----------
-        todo: string (one of 'left', 'right', 'bottom', 'top')
-            margin to alter.
+        todo : {'left', 'right', 'bottom', 'top'}
+            The margin to alter.
 
-        size: float
-            Minimum size of the margin .  If it is larger than the
+        size : float
+            Minimum size of the margin.  If it is larger than the
             existing minimum it updates the margin size. Fraction of
             figure size.
         """
@@ -333,11 +333,11 @@ def edit_outer_margin_mins(self, margin, ss):
 
         Parameters
         ----------
-        margin: dict
+        margin : dict
             size of margins in a dict with keys 'left', 'right', 'bottom',
             'top'
 
-        ss: SubplotSpec
+        ss : SubplotSpec
             defines the subplotspec these margins should be applied to
         """
 
diff --git a/lib/matplotlib/_mathtext.py b/lib/matplotlib/_mathtext.py
@@ -81,10 +81,10 @@ def __init__(self, default_font_prop, mathtext_backend):
         """
         Parameters
         ----------
-        default_font_prop: `~.font_manager.FontProperties`
+        default_font_prop : `~.font_manager.FontProperties`
             The default non-math font, or the base font for Unicode (generic)
             font rendering.
-        mathtext_backend: `MathtextBackend` subclass
+        mathtext_backend : `MathtextBackend` subclass
             Backend to which rendering is actually delegated.
         """
         self.default_font_prop = default_font_prop
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1012,7 +1012,7 @@ def hlines(self, y, xmin, xmax, colors=None, linestyles='solid',
         See Also
         --------
         vlines : vertical lines
-        axhline: horizontal line across the Axes
+        axhline : horizontal line across the Axes
         """
 
         # We do the conversion first since not all unitized data is uniform
@@ -1089,7 +1089,7 @@ def vlines(self, x, ymin, ymax, colors=None, linestyles='solid',
         See Also
         --------
         hlines : horizontal lines
-        axvline: vertical line across the Axes
+        axvline : vertical line across the Axes
         """
 
         # We do the conversion first since not all unitized data is uniform
@@ -2221,7 +2221,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
 
         See Also
         --------
-        barh: Plot a horizontal bar plot.
+        barh : Plot a horizontal bar plot.
 
         Notes
         -----
@@ -2490,7 +2490,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
 
         See Also
         --------
-        bar: Plot a vertical bar plot.
+        bar : Plot a vertical bar plot.
 
         Notes
         -----
@@ -2831,7 +2831,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
         shadow : bool, default: False
             Draw a shadow beneath the pie.
 
-        normalize: None or bool, default: None
+        normalize : None or bool, default: None
             When *True*, always make a full pie by normalizing x so that
             ``sum(x) == 1``. *False* makes a partial pie if ``sum(x) <= 1``
             and raises a `ValueError` for ``sum(x) > 1``.
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -451,9 +451,9 @@ def paint_path(cls, fill, stroke):
 
         Parameters
         ----------
-        fill: bool
+        fill : bool
             Fill the path with the fill color.
-        stroke: bool
+        stroke : bool
             Stroke the outline of the path with the line color.
         """
         if stroke:
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -836,7 +836,7 @@ def set_alpha(self, alpha):
 
         Parameters
         ----------
-        alpha: float or array of float or None
+        alpha : float or array of float or None
             If not None, *alpha* values must be between 0 and 1, inclusive.
             If an array is provided, its length must match the number of
             elements in the collection.  Masked values and nans are not
@@ -1369,7 +1369,7 @@ def __init__(self, segments,     # Can be None.
         """
         Parameters
         ----------
-        segments: list of array-like
+        segments : list of array-like
             A sequence of (*line0*, *line1*, *line2*), where::
 
                 linen = (x0, y0), (x1, y1), ... (xm, ym)
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -275,7 +275,7 @@ def get_epoch():
 
     Returns
     -------
-    epoch: str
+    epoch : str
         String for the epoch (parsable by `numpy.datetime64`).
     """
     global _epoch
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -1288,26 +1288,26 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False,
         """
         Parameters
         ----------
-        width: float, default: 0.001
+        width : float, default: 0.001
             Width of full arrow tail.
 
-        length_includes_head: bool, default: False
+        length_includes_head : bool, default: False
             True if head is to be counted in calculating the length.
 
-        head_width: float or None, default: 3*width
+        head_width : float or None, default: 3*width
             Total width of the full arrow head.
 
-        head_length: float or None, default: 1.5*head_width
+        head_length : float or None, default: 1.5*head_width
             Length of arrow head.
 
-        shape: ['full', 'left', 'right'], default: 'full'
+        shape : {'full', 'left', 'right'}, default: 'full'
             Draw the left-half, right-half, or full arrow.
 
-        overhang: float, default: 0
+        overhang : float, default: 0
             Fraction that the arrow is swept back (0 overhang means
             triangular shape). Can be negative or greater than one.
 
-        head_starts_at_zero: bool, default: False
+        head_starts_at_zero : bool, default: False
             If True, the head starts being drawn at coordinate 0
             instead of ending at coordinate 0.
 
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -1699,15 +1699,15 @@ def _generate_normals(self, polygons):
 
         Parameters
         ----------
-        polygons: list of (M_i, 3) array-like, or (..., M, 3) array-like
+        polygons : list of (M_i, 3) array-like, or (..., M, 3) array-like
             A sequence of polygons to compute normals for, which can have
             varying numbers of vertices. If the polygons all have the same
             number of vertices and array is passed, then the operation will
             be vectorized.
 
         Returns
         -------
-        normals: (..., 3) array-like
+        normals : (..., 3) array-like
             A normal vector estimated for the polygon.
 
         """
