Merge pull request matplotlib#20432 from anntzer/docstyle

Small doc cleanups.

Author: timhoffm

lib/matplotlib/backends/backend_pdf.py

@@ -2640,11 +2640,8 @@ def savefig(self, figure=None, **kwargs):
 
         Parameters
         ----------
-        figure : `.Figure` or int, optional
-            Specifies what figure is saved to file. If not specified, the
-            active figure is saved. If a `.Figure` instance is provided, this
-            figure is saved. If an int is specified, the figure instance to
-            save is looked up by number.
+        figure : `.Figure` or int, default: the active figure
+            The figure, or index of the figure, that is saved to the file.
         """
         if not isinstance(figure, Figure):
             if figure is None:

lib/matplotlib/backends/backend_pgf.py

@@ -1019,11 +1019,8 @@ def savefig(self, figure=None, **kwargs):
 
         Parameters
         ----------
-        figure : `.Figure` or int, optional
-            Specifies what figure is saved to file. If not specified, the
-            active figure is saved. If a `.Figure` instance is provided, this
-            figure is saved. If an int is specified, the figure instance to
-            save is looked up by number.
+        figure : `.Figure` or int, default: the active figure
+            The figure, or index of the figure, that is saved to the file.
         """
         if not isinstance(figure, Figure):
             if figure is None:

lib/matplotlib/gridspec.py

@@ -568,7 +568,7 @@ def get_topmost_subplotspec(self):
 
 class SubplotSpec:
     """
-    Specifies the location of a subplot in a `GridSpec`.
+    The location of a subplot in a `GridSpec`.
 
     .. note::
 

lib/matplotlib/markers.py

@@ -406,7 +406,7 @@ def _set_tuple_marker(self):
 
     def _set_mathtext_path(self):
         """
-        Draws mathtext markers '$...$' using TextPath object.
+        Draw mathtext markers '$...$' using TextPath object.
 
         Submitted by tcb
         """

tutorials/intermediate/gridspec.py

@@ -5,27 +5,24 @@
 
 How to create grid-shaped combinations of axes.
 
-    :func:`~matplotlib.pyplot.subplots`
-        Perhaps the primary function used to create figures and axes.
-        It's also similar to :func:`.matplotlib.pyplot.subplot`,
-        but creates and places all axes on the figure at once.  See also
-        `matplotlib.figure.Figure.subplots`.
-
-    :class:`~matplotlib.gridspec.GridSpec`
-        Specifies the geometry of the grid that a subplot will be
-        placed. The number of rows and number of columns of the grid
-        need to be set. Optionally, the subplot layout parameters
-        (e.g., left, right, etc.) can be tuned.
-
-    :class:`~matplotlib.gridspec.SubplotSpec`
-        Specifies the location of the subplot in the given *GridSpec*.
-
-    :func:`~matplotlib.pyplot.subplot2grid`
-        A helper function that is similar to
-        :func:`~matplotlib.pyplot.subplot`,
-        but uses 0-based indexing and let subplot to occupy multiple cells.
-        This function is not covered in this tutorial.
-
+`~matplotlib.pyplot.subplots`
+    The primary function used to create figures and axes.  It is similar to
+    `.pyplot.subplot`, but creates and places all axes on the figure at once.
+    See also `.Figure.subplots`.
+
+`~matplotlib.gridspec.GridSpec`
+    Specifies the geometry of the grid that a subplot will be
+    placed. The number of rows and number of columns of the grid
+    need to be set. Optionally, the subplot layout parameters
+    (e.g., left, right, etc.) can be tuned.
+
+`~matplotlib.gridspec.SubplotSpec`
+    Specifies the location of the subplot in the given `.GridSpec`.
+
+`~matplotlib.pyplot.subplot2grid`
+    A helper function that is similar to `.pyplot.subplot`,
+    but uses 0-based indexing and let subplot to occupy multiple cells.
+    This function is not covered in this tutorial.
 """
 
 import matplotlib.pyplot as plt