Use str instead of string as type in docstrings

Author: timhoffm

lib/matplotlib/__init__.py

@@ -1479,7 +1479,7 @@ def func(ax, *args, **kwargs): ...
     replace_names : list of str or None, optional, default: None
         The list of parameter names for which lookup into *data* should be
         attempted. If None, replacement is attempted for all arguments.
-    label_namer : string, optional, default: None
+    label_namer : str, optional, default: None
         If set e.g. to "namer" (which must be a kwarg in the function's
         signature -- not as ``**kwargs``), if the *namer* argument passed in is
         a (string) key of *data* and no *label* kwarg is passed, then use the

lib/matplotlib/animation.py

@@ -195,7 +195,7 @@ def setup(self, fig, outfile, dpi=None):
         ----------
         fig : `~matplotlib.figure.Figure`
             The figure object that contains the information for frames
-        outfile : string
+        outfile : str
             The filename of the resulting movie file
         dpi : int, optional
             The DPI (or resolution) for the file.  This controls the size
@@ -231,7 +231,8 @@ def saving(self, fig, outfile, dpi, *args, **kwargs):
 
 
 class MovieWriter(AbstractMovieWriter):
-    '''Base class for writing movies.
+    """
+    Base class for writing movies.
 
     This is a base class for MovieWriter subclasses that write a movie frame
     data to a pipe. You cannot instantiate this class directly.
@@ -240,39 +241,38 @@ class MovieWriter(AbstractMovieWriter):
     Attributes
     ----------
     frame_format : str
-        The format used in writing frame data, defaults to 'rgba'
+        The format used in writing frame data, defaults to 'rgba'.
     fig : `~matplotlib.figure.Figure`
         The figure to capture data from.
         This must be provided by the sub-classes.
 
-    '''
+    """
 
     def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
                  metadata=None):
-        '''MovieWriter
-
+        """
         Parameters
         ----------
         fps : int
             Framerate for movie.
-        codec : string or None, optional
-            The codec to use. If ``None`` (the default) the ``animation.codec``
-            rcParam is used.
+        codec : str or None, optional
+            The codec to use. If ``None`` (the default) :rc:`animation.codec`
+            is used.
         bitrate : int or None, optional
             The bitrate for the saved movie file, which is one way to control
             the output file size and quality. The default value is ``None``,
-            which uses the ``animation.bitrate`` rcParam.  A value of -1
-            implies that the bitrate should be determined automatically by the
-            underlying utility.
-        extra_args : list of strings or None, optional
+            which uses :rc:`animation.bitrate`.  A value of -1 implies that
+            the bitrate should be determined automatically by the underlying
+            utility.
+        extra_args : list of str or None, optional
             A list of extra string arguments to be passed to the underlying
             movie utility. The default is ``None``, which passes the additional
-            arguments in the ``animation.extra_args`` rcParam.
+            arguments in :rc:`animation.extra_args`.
         metadata : Dict[str, str] or None
             A dictionary of keys and values for metadata to include in the
             output file. Some keys that may be of use include:
             title, artist, genre, subject, copyright, srcform, comment.
-        '''
+        """
         if self.__class__ is MovieWriter:
             # TODO MovieWriter is still an abstract class and needs to be
             #      extended with a mixin. This should be clearer in naming

lib/matplotlib/axes/_axes.py

@@ -364,7 +364,7 @@ def legend(self, *args, **kwargs):
             The length of handles and labels should be the same in this
             case. If they are not, they are truncated to the smaller length.
 
-        labels : sequence of strings, optional
+        labels : list of str, optional
             A list of labels to show next to the artists.
             Use this together with *handles*, if you need full control on what
             is shown in the legend and the automatic mechanism described above
@@ -1061,7 +1061,7 @@ def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
 
         linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
 
-        label : string, optional, default: ''
+        label : str, optional, default: ''
 
         Returns
         -------
@@ -1139,7 +1139,7 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
 
         linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
 
-        label : string, optional, default: ''
+        label : str, optional, default: ''
 
         Returns
         -------
@@ -2218,7 +2218,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
         linewidth : scalar or array-like, optional
             Width of the bar edge(s). If 0, don't draw edges.
 
-        tick_label : string or array-like, optional
+        tick_label : str or array-like, optional
             The tick labels of the bars.
             Default: None (Use default numeric labels.)
 
@@ -2514,7 +2514,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
         linewidth : scalar or array-like, optional
             Width of the bar edge(s). If 0, don't draw edges.
 
-        tick_label : string or array-like, optional
+        tick_label : str or array-like, optional
             The tick labels of the bars.
             Default: None (Use default numeric labels.)
 
@@ -2862,7 +2862,7 @@ def pie(self, x, explode=None, labels=None, colors=None,
             will cycle.  If *None*, will use the colors in the currently
             active cycle.
 
-        autopct : None (default), string, or function, optional
+        autopct : None (default), str, or function, optional
             If not *None*, is a string or function used to label the wedges
             with their numeric value.  The label will be placed inside the
             wedge.  If it is a format string, the label will be ``fmt%pct``.
@@ -3097,7 +3097,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
             See :doc:`/gallery/statistics/errorbar_features`
             for an example on the usage of ``xerr`` and ``yerr``.
 
-        fmt : plot format string, optional, default: ''
+        fmt : str, optional, default: ''
             The format for the data points / data lines. See `.plot` for
             details.
 

lib/matplotlib/axes/_base.py

@@ -2924,7 +2924,7 @@ def tick_params(self, axis='both', **kwargs):
             Transparency of gridlines: 0 (transparent) to 1 (opaque).
         grid_linewidth : float
             Width of gridlines in points.
-        grid_linestyle : string
+        grid_linestyle : str
             Any valid `~matplotlib.lines.Line2D` line style spec.
 
         Examples
@@ -3755,7 +3755,7 @@ def xaxis_date(self, tz=None):
 
         Parameters
         ----------
-        tz : string or `tzinfo` instance, optional
+        tz : str or `tzinfo` instance, optional
             Timezone.  Defaults to :rc:`timezone`.
         """
         # should be enough to inform the unit conversion interface
@@ -3768,7 +3768,7 @@ def yaxis_date(self, tz=None):
 
         Parameters
         ----------
-        tz : string or `tzinfo` instance, optional
+        tz : str or `tzinfo` instance, optional
             Timezone.  Defaults to :rc:`timezone`.
         """
         self.yaxis.axis_date(tz)

lib/matplotlib/axes/_secondary_axes.py

@@ -121,12 +121,12 @@ def set_location(self, location):
 
         Parameters
         ----------
-        location : string or scalar
+        location : {'top', 'bottom', 'left', 'right'} or float
             The position to put the secondary axis.  Strings can be 'top' or
             'bottom' for orientation='x' and 'right' or 'left' for
-            orientation='y', scalar can be a float indicating the relative
-            position on the parent axes to put the new axes, 0.0 being the
-            bottom (or left) and 1.0 being the top (or right).
+            orientation='y'. A float indicates the relative position on the
+            parent axes to put the new axes, 0.0 being the bottom (or left)
+            and 1.0 being the top (or right).
         """
 
         # This puts the rectangle into figure-relative coordinates.
@@ -374,12 +374,12 @@ def set_color(self, color):
 
 Parameters
 ----------
-location : string or scalar
+location : {'top', 'bottom', 'left', 'right'} or float
     The position to put the secondary axis.  Strings can be 'top' or
-    'bottom', for x-oriented axises or 'left' or 'right' for y-oriented axises
-    or a scalar can be a float indicating the relative position
-    on the axes to put the new axes (0 being the bottom (left), and 1.0 being
-    the top (right).)
+    'bottom' for orientation='x' and 'right' or 'left' for
+    orientation='y'. A float indicates the relative position on the
+    parent axes to put the new axes, 0.0 being the bottom (or left)
+    and 1.0 being the top (or right).
 
 functions : 2-tuple of func, or Transform with an inverse
 

lib/matplotlib/backend_bases.py

@@ -3168,8 +3168,8 @@ def trigger_tool(self, name):
 
         Parameters
         ----------
-        name : string
-            Name (id) of the tool triggered from within the container
+        name : str
+            Name (id) of the tool triggered from within the container.
         """
         self.toolmanager.trigger_tool(name, sender=self)
 
@@ -3184,7 +3184,7 @@ def add_toolitem(self, name, group, position, image, description, toggle):
 
         Parameters
         ----------
-        name : string
+        name : str
             Name of the tool to add, this gets used as the tool's ID and as the
             default label of the buttons
         group : String
@@ -3226,7 +3226,7 @@ def remove_toolitem(self, name):
 
         Parameters
         ----------
-        name : string
+        name : str
             Name of the tool to remove.
         """
         raise NotImplementedError

lib/matplotlib/backend_managers.py

@@ -163,8 +163,8 @@ def get_tool_keymap(self, name):
 
         Parameters
         ----------
-        name : string
-            Name of the Tool
+        name : str
+            Name of the Tool.
 
         Returns
         -------
@@ -184,8 +184,8 @@ def update_keymap(self, name, *keys):
 
         Parameters
         ----------
-        name : string
-            Name of the Tool
+        name : str
+            Name of the Tool.
         keys : keys to associate with the Tool
         """
 
@@ -207,8 +207,8 @@ def remove_tool(self, name):
 
         Parameters
         ----------
-        name : string
-            Name of the Tool
+        name : str
+            Name of the Tool.
         """
 
         tool = self.get_tool(name)
@@ -355,8 +355,8 @@ def trigger_tool(self, name, sender=None, canvasevent=None, data=None):
 
         Parameters
         ----------
-        name : string
-            Name of the tool
+        name : str
+            Name of the tool.
         sender : object
             Object that wishes to trigger the tool
         canvasevent : Event

lib/matplotlib/backend_tools.py

@@ -49,7 +49,7 @@ class ToolBase:
         ToolManager that controls this Tool
     figure : `FigureCanvas`
         Figure instance that is affected by this Tool
-    name : string
+    name : str
         Used as **Id** of the tool, has to be unique among tools of the same
         ToolManager
     """

lib/matplotlib/backends/backend_pdf.py

@@ -437,7 +437,7 @@ def __init__(self, filename, metadata=None):
         Parameters
         ----------
 
-        filename : file-like object or string
+        filename : str or path-like or file-like
             Output target; if a string, a file will be opened for writing.
         metadata : dict from strings to strings and dates
             Information dictionary object (see PDF reference section 10.2.1
@@ -2472,7 +2472,7 @@ def __init__(self, filename, keep_empty=True, metadata=None):
 
         Parameters
         ----------
-        filename : str
+        filename : str or path-like or file-like
             Plots using :meth:`PdfPages.savefig` will be written to a file at
             this location. The file is opened at once and any older file with
             the same name is overwritten.

lib/matplotlib/backends/backend_pgf.py

@@ -989,7 +989,7 @@ def __init__(self, filename, *, keep_empty=True, metadata=None):
 
         Parameters
         ----------
-        filename : str
+        filename : str or path-like
             Plots using :meth:`PdfPages.savefig` will be written to a file at
             this location. Any older file with the same name is overwritten.
         keep_empty : bool, optional