Merge pull request #16093 from timhoffm/auto-backport-of-pr-16079-on-v3.2.x

timhoffm · web-flow · commit 6fcb260ee6af · 2020-01-04T19:30:52.000+01:00
Backport PR #16079 on branch v3.2.x (Fix restuctured text formatting)
diff --git a/doc/users/prev_whats_new/whats_new_3.1.0.rst b/doc/users/prev_whats_new/whats_new_3.1.0.rst
@@ -96,7 +96,7 @@ show in the legend manually.  Now,
 handles and labels for a scatter plot in an automated way. This makes
 creating a legend for a scatter plot as easy as
 
-.. plot ::
+.. plot::
 
     scatter = plt.scatter([1,2,3], [4,5,6], c=[7,2,3])
     plt.legend(*scatter.legend_elements())
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -1462,11 +1462,12 @@ def _preprocess_data(func=None, *, replace_names=None, label_namer=None):
     """
     A decorator to add a 'data' kwarg to a function.
 
-    ::
+    When applied::
+
         @_preprocess_data()
         def func(ax, *args, **kwargs): ...
 
-    is a function with signature ``decorated(ax, *args, data=None, **kwargs)``
+    the signature is modified to ``decorated(ax, *args, data=None, **kwargs)``
     with the following behavior:
 
     - if called with ``data=None``, forward the other arguments to ``func``;
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1230,7 +1230,7 @@ class DrawEvent(Event):
     updated.  Any extra artists drawn to the canvas's renderer will
     be reflected without an explicit call to ``blit``.
 
-    .. warning ::
+    .. warning::
 
        Calling ``canvas.draw`` and ``canvas.blit`` in these callbacks may
        not be safe with all backends and may cause infinite recursion.
@@ -1407,6 +1407,7 @@ class MouseEvent(LocationEvent):
     Examples
     --------
     ::
+
         def on_press(event):
             print('you pressed', event.button, event.xdata, event.ydata)
 
@@ -1504,6 +1505,7 @@ class KeyEvent(LocationEvent):
     Examples
     --------
     ::
+
         def on_key(event):
             print('you pressed', event.key, event.xdata, event.ydata)
 
@@ -2192,6 +2194,7 @@ def func(event: Event) -> Any
         Examples
         --------
         ::
+
             def on_press(event):
                 print('you pressed', event.button, event.xdata, event.ydata)
 
@@ -2207,6 +2210,7 @@ def mpl_disconnect(self, cid):
         Examples
         --------
         ::
+
             cid = canvas.mpl_connect('button_press_event', on_press)
             # ... later
             canvas.mpl_disconnect(cid)
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -2152,6 +2152,7 @@ class _classproperty:
     Examples
     --------
     ::
+
         class C:
             @classproperty
             def foo(cls):
diff --git a/lib/matplotlib/cbook/deprecation.py b/lib/matplotlib/cbook/deprecation.py
@@ -269,6 +269,7 @@ def _rename_parameter(since, old, new, func=None):
     Examples
     --------
     ::
+
         @_rename_parameter("3.1", "bad_name", "good_name")
         def func(good_name): ...
     """
@@ -326,6 +327,7 @@ def _delete_parameter(since, name, func=None):
     Examples
     --------
     ::
+
         @_delete_parameter("3.1", "unused")
         def func(used_arg, other_arg, unused, more_args): ...
     """
diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -866,11 +866,11 @@ class ListedColormap(Colormap):
     N : int, optional
         Number of entries in the map. The default is *None*, in which case
         there is one colormap entry for each element in the list of colors.
-        If::
+        If ::
 
             N < len(colors)
 
-        the list will be truncated at *N*. If::
+        the list will be truncated at *N*. If ::
 
             N > len(colors)
 
@@ -948,7 +948,7 @@ def __init__(self, vmin=None, vmax=None, clip=False):
         processed.  That is, *__call__(A)* calls *autoscale_None(A)*.
         If *clip* is *True* and the given value falls outside the range,
         the returned value will be 0 or 1, whichever is closer.
-        Returns 0 if::
+        Returns 0 if ::
 
             vmin==vmax
 
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -691,7 +691,7 @@ class ContourSet(cm.ScalarMappable, ContourLabeler):
         List of all the polygon segments for all the *levels*.
         For contour lines ``len(allsegs) == len(levels)``, and for
         filled contour regions ``len(allsegs) = len(levels)-1``. The lists
-        should look like::
+        should look like ::
 
             level0segs = [polygon0, polygon1, ...]
             polygon0 = [[x0, y0], [x1, y1], ...]
@@ -701,7 +701,7 @@ class ContourSet(cm.ScalarMappable, ContourLabeler):
         described and used in Path. This is used to allow multiply-
         connected paths such as holes within filled polygons.
         If not ``None``, ``len(allkinds) == len(allsegs)``. The lists
-        should look like::
+        should look like ::
 
             level0kinds = [polygon0kinds, ...]
             polygon0kinds = [vertexcode0, vertexcode1, ...]
@@ -757,7 +757,7 @@ def __init__(self, ax, *args,
             List of all the polygon segments for all the *levels*.
             For contour lines ``len(allsegs) == len(levels)``, and for
             filled contour regions ``len(allsegs) = len(levels)-1``. The lists
-            should look like::
+            should look like ::
 
                 level0segs = [polygon0, polygon1, ...]
                 polygon0 = [[x0, y0], [x1, y1], ...]
@@ -767,7 +767,7 @@ def __init__(self, ax, *args,
             described and used in Path. This is used to allow multiply-
             connected paths such as holes within filled polygons.
             If not ``None``, ``len(allkinds) == len(allsegs)``. The lists
-            should look like::
+            should look like ::
 
                 level0kinds = [polygon0kinds, ...]
                 polygon0kinds = [vertexcode0, vertexcode1, ...]
diff --git a/lib/matplotlib/font_manager.py b/lib/matplotlib/font_manager.py
@@ -160,7 +160,7 @@ def list_fonts(directory, extensions):
 def win32FontDirectory():
     r"""
     Return the user-specified font directory for Win32.  This is
-    looked up from the registry key::
+    looked up from the registry key ::
 
       \\HKEY_CURRENT_USER\Software\Microsoft\Windows\CurrentVersion\Explorer\Shell Folders\Fonts
 
@@ -594,7 +594,7 @@ class FontProperties:
         absolute font size, e.g., 12
 
     The default font property for TrueType fonts (as specified in the
-    default rcParams) is::
+    default rcParams) is ::
 
       sans-serif, normal, normal, normal, normal, scalable.
 
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -414,7 +414,7 @@ def set_linestyle(self, ls):
 
         Alternatively a dash tuple of the following form can be provided::
 
-            (offset, onoffseq),
+            (offset, onoffseq)
 
         where ``onoffseq`` is an even length tuple of on and off ink in points.
 
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -136,12 +136,12 @@ def uninstall_repl_displayhook():
     """
     Uninstall the matplotlib display hook.
 
-    .. warning
+    .. warning::
 
        Need IPython >= 2 for this to work.  For IPython < 2 will raise a
        ``NotImplementedError``
 
-    .. warning
+    .. warning::
 
        If you are using vanilla python and have installed another
        display hook this will reset ``sys.displayhook`` to what ever
diff --git a/lib/mpl_toolkits/axes_grid1/axes_size.py b/lib/mpl_toolkits/axes_grid1/axes_size.py
@@ -225,9 +225,8 @@ def get_size(self, renderer):
 class Fraction(_Base):
     """
     An instance whose size is a *fraction* of the *ref_size*.
-    ::
 
-      >>> s = Fraction(0.3, AxesX(ax))
+    >>> s = Fraction(0.3, AxesX(ax))
 
     """
     def __init__(self, fraction, ref_size):
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
@@ -146,7 +146,7 @@ def convert_zunits(self, z):
         For artists in an axes, if the zaxis has units support,
         convert *z* using zaxis unit type
 
-        .. versionadded :: 1.2.1
+        .. versionadded:: 1.2.1
 
         """
         return self.zaxis.convert_units(z)
@@ -333,7 +333,7 @@ def get_autoscale_on(self):
         """
         Get whether autoscaling is applied for all axes on plot commands
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
         """
         return super().get_autoscale_on() and self.get_autoscalez_on()
@@ -342,7 +342,7 @@ def get_autoscalez_on(self):
         """
         Get whether autoscaling for the z-axis is applied on plot commands
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
         """
         return self._autoscaleZon
@@ -351,7 +351,7 @@ def set_autoscale_on(self, b):
         """
         Set whether autoscaling is applied on plot commands
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
 
         Parameters
@@ -393,7 +393,8 @@ def margins(self, *margins, x=None, y=None, z=None, tight=True):
         """
         Convenience method to set or retrieve autoscaling margins.
 
-        signatures::
+        Call signatures::
+
             margins()
 
         returns xmargin, ymargin, zmargin
@@ -508,11 +509,11 @@ def autoscale_view(self, tight=None, scalex=True, scaley=True,
         Note that this function applies to the 3D axes, and as such
         adds the *scalez* to the function arguments.
 
-        .. versionchanged :: 1.1.0
+        .. versionchanged:: 1.1.0
             Function signature was changed to better match the 2D version.
             *tight* is now explicitly a kwarg and placed first.
 
-        .. versionchanged :: 1.2.1
+        .. versionchanged:: 1.2.1
             This is now fully functional.
 
         """
@@ -763,7 +764,7 @@ def get_xlim3d(self):
     get_xlim = get_xlim3d
     if get_xlim.__doc__ is not None:
         get_xlim.__doc__ += """
-        .. versionchanged :: 1.1.0
+        .. versionchanged:: 1.1.0
             This function now correctly refers to the 3D x-limits
         """
 
@@ -773,7 +774,7 @@ def get_ylim3d(self):
     get_ylim = get_ylim3d
     if get_ylim.__doc__ is not None:
         get_ylim.__doc__ += """
-        .. versionchanged :: 1.1.0
+        .. versionchanged:: 1.1.0
             This function now correctly refers to the 3D y-limits.
         """
 
@@ -855,7 +856,7 @@ def get_zmajorticklabels(self):
         """
         Get the ztick labels as a list of Text instances
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         """
         return self.zaxis.get_majorticklabels()
 
@@ -867,7 +868,7 @@ def get_zminorticklabels(self):
             Minor ticks are not supported. This function was added
             only for completeness.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         """
         return self.zaxis.get_minorticklabels()
 
@@ -907,7 +908,7 @@ def zaxis_date(self, tz=None):
             Axes3D objects do not officially support dates for ticks,
             and so this may or may not work as expected.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
         """
         self.zaxis.axis_date(tz)
@@ -1212,7 +1213,7 @@ def get_zlabel(self):
         """
         Get the z-label text string.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
         """
         label = self.zaxis.get_label()
@@ -1245,7 +1246,7 @@ def grid(self, b=True, **kwargs):
             :meth:`matplotlib.axes.Axes.grid`, but it is intended to
             eventually support that behavior.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         '''
         # TODO: Operate on each axes separately
         if len(kwargs):
@@ -1264,7 +1265,7 @@ def locator_params(self, axis='both', tight=None, **kwargs):
         can also take a value of 'z' to apply parameters to the
         z axis.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
         """
         _x = axis in ['x', 'both']
@@ -1299,7 +1300,7 @@ def tick_params(self, axis='both', **kwargs):
         .. note::
            Axes3D currently ignores some of these settings.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         """
         cbook._check_in_list(['x', 'y', 'z', 'both'], axis=axis)
         if axis in ['x', 'y', 'both']:
@@ -1318,7 +1319,7 @@ def invert_zaxis(self):
         """
         Invert the z-axis.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
             This function was added, but not tested. Please report any bugs.
         """
         bottom, top = self.get_zlim()
@@ -1328,7 +1329,7 @@ def zaxis_inverted(self):
         '''
         Returns True if the z-axis is inverted.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         '''
         bottom, top = self.get_zlim()
         return top < bottom
@@ -1337,7 +1338,7 @@ def get_zbound(self):
         """
         Return the lower and upper z-axis bounds, in increasing order.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         """
         bottom, top = self.get_zlim()
         if bottom < top:
@@ -1351,7 +1352,7 @@ def set_zbound(self, lower=None, upper=None):
         This method will honor axes inversion regardless of parameter order.
         It will not change the :attr:`_autoscaleZon` attribute.
 
-        .. versionadded :: 1.1.0
+        .. versionadded:: 1.1.0
         """
         if upper is None and np.iterable(lower):
             lower, upper = lower
