Merge pull request #19421 from anntzer/lowercasetypegenerics

QuLogic · web-flow · commit 94067c651fec · 2021-02-01T18:57:20.000-05:00
Switch to documenting generic collections in lowercase.
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -285,7 +285,7 @@ def __init__(self, fps=5, codec=None, bitrate=None, extra_args=None,
             Extra command-line arguments passed to the underlying movie
             encoder.  The default, None, means to use
             :rc:`animation.[name-of-encoder]_args` for the builtin writers.
-        metadata : Dict[str, str], default: {}
+        metadata : dict[str, str], default: {}
             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.
@@ -1024,7 +1024,7 @@ class to use, such as 'ffmpeg'.
             encoder.  The default, None, means to use
             :rc:`animation.[name-of-encoder]_args` for the builtin writers.
 
-        metadata : Dict[str, str], default: {}
+        metadata : dict[str, str], default: {}
             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.
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -6895,7 +6895,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
             return tops[0], bins, patches[0]
         else:
             patch_type = ("BarContainer" if histtype.startswith("bar")
-                          else "List[Polygon]")
+                          else "list[Polygon]")
             return tops, bins, cbook.silent_list(patch_type, patches)
 
     @_preprocess_data()
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1117,7 +1117,7 @@ def __init__(self, interval=None, callbacks=None):
         interval : int, default: 1000ms
             The time between timer events in milliseconds.  Will be stored as
             ``timer.interval``.
-        callbacks : List[Tuple[callable, Tuple, Dict]]
+        callbacks : list[tuple[callable, tuple, dict]]
             List of (func, args, kwargs) tuples that will be called upon
             timer events.  This list is accessible as ``timer.callbacks`` and
             can be manipulated directly, or the functions `add_callback` and
@@ -2405,7 +2405,7 @@ def new_timer(self, interval=None, callbacks=None):
         interval : int
             Timer interval in milliseconds.
 
-        callbacks : List[Tuple[callable, Tuple, Dict]]
+        callbacks : list[tuple[callable, tuple, dict]]
             Sequence of (func, args, kwargs) where ``func(*args, **kwargs)``
             will be executed by the timer every *interval*.
 
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -151,7 +151,7 @@ def _create_pdf_info_dict(backend, metadata):
     backend : str
         The name of the backend to use in the Producer value.
 
-    metadata : Dict[str, Union[str, datetime, Name]]
+    metadata : dict[str, Union[str, datetime, Name]]
         A dictionary of metadata supplied by the user with information
         following the PDF specification, also defined in
         `~.backend_pdf.PdfPages` below.
@@ -161,7 +161,7 @@ def _create_pdf_info_dict(backend, metadata):
 
     Returns
     -------
-    Dict[str, Union[str, datetime, Name]]
+    dict[str, Union[str, datetime, Name]]
         A validated dictionary of metadata.
     """
 
diff --git a/lib/matplotlib/backends/backend_svg.py b/lib/matplotlib/backends/backend_svg.py
@@ -1293,7 +1293,7 @@ def print_svg(self, filename, *args, **kwargs):
         filename : str or path-like or file-like
             Output target; if a string, a file will be opened for writing.
 
-        metadata : Dict[str, Any], optional
+        metadata : dict[str, Any], optional
             Metadata in the SVG file defined as key-value pairs of strings,
             datetimes, or lists of strings, e.g., ``{'Creator': 'My software',
             'Contributor': ['Me', 'My Friend'], 'Title': 'Awesome'}``.
diff --git a/lib/matplotlib/bezier.py b/lib/matplotlib/bezier.py
@@ -129,13 +129,13 @@ def find_bezier_t_intersecting_with_closedpath(
         A function returning x, y coordinates of the Bezier at parameter *t*.
         It must have the signature::
 
-            bezier_point_at_t(t: float) -> Tuple[float, float]
+            bezier_point_at_t(t: float) -> tuple[float, float]
 
     inside_closedpath : callable
         A function returning True if a given point (x, y) is inside the
         closed path. It must have the signature::
 
-            inside_closedpath(point: Tuple[float, float]) -> bool
+            inside_closedpath(point: tuple[float, float]) -> bool
 
     t0, t1 : float
         Start parameters for the search.
@@ -204,20 +204,22 @@ def __call__(self, t):
 
         Parameters
         ----------
-        t : float (k,), array_like
+        t : float (k,) array_like
             Points at which to evaluate the curve.
 
         Returns
         -------
-        float (k, d), array_like
+        float (k, d) array_like
             Value of the curve for each point in *t*.
         """
         t = np.asarray(t)
         return (np.power.outer(1 - t, self._orders[::-1])
                 * np.power.outer(t, self._orders)) @ self._px
 
     def point_at_t(self, t):
-        """Evaluate curve at a single point *t*. Returns a Tuple[float*d]."""
+        """
+        Evaluate the curve at a single point, returning a tuple of *d* floats.
+        """
         return tuple(self(t))
 
     @property
@@ -407,7 +409,7 @@ def inside_circle(cx, cy, r):
 
     The returned function has the signature::
 
-        f(xy: Tuple[float, float]) -> bool
+        f(xy: tuple[float, float]) -> bool
     """
     r2 = r ** 2
 
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -915,18 +915,15 @@ def legend_elements(self, variable_name='x', str_format=str):
         ----------
         variable_name : str
             The string used inside the inequality used on the labels.
-
         str_format : function: float -> str
             Function used to format the numbers in the labels.
 
         Returns
         -------
-        artists : List[`.Artist`]
+        artists : list[`.Artist`]
             A list of the artists.
-
-        labels : List[str]
+        labels : list[str]
             A list of the labels.
-
         """
         artists = []
         labels = []
@@ -1706,7 +1703,7 @@ def _initialize_x_y(self, z):
             iterable is shorter than the number of contour levels
             it will be repeated as necessary.
 
-        hatches : List[str], optional
+        hatches : list[str], optional
             *Only applies to* `.contourf`.
 
             A list of cross hatch patterns to use on the filled areas.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1711,9 +1711,9 @@ def _identify_keys_and_nested(layout):
 
             Returns
             -------
-            unique_ids : Set[object]
+            unique_ids : set
                 The unique non-sub layout entries in this layout
-            nested : Dict[Tuple[int, int]], 2D object array
+            nested : dict[tuple[int, int]], 2D object array
             """
             unique_ids = set()
             nested = {}
@@ -1735,19 +1735,16 @@ def _do_layout(gs, layout, unique_ids, nested):
             Parameters
             ----------
             gs : GridSpec
-
             layout : 2D object array
                 The input converted to a 2D numpy array for this level.
-
-            unique_ids : Set[object]
+            unique_ids : set
                 The identified scalar labels at this level of nesting.
-
-            nested : Dict[Tuple[int, int]], 2D object array
-                The identified nested layouts if any.
+            nested : dict[tuple[int, int]], 2D object array
+                The identified nested layouts, if any.
 
             Returns
             -------
-            Dict[label, Axes]
+            dict[label, Axes]
                 A flat dict of all of the Axes created.
             """
             rows, cols = layout.shape
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -546,8 +546,8 @@ def set_markevery(self, every):
 
         Parameters
         ----------
-        every : None or int or (int, int) or slice or List[int] or float or \
-(float, float) or List[bool]
+        every : None or int or (int, int) or slice or list[int] or float or \
+(float, float) or list[bool]
             Which markers to plot.
 
             - every=None, every point will be plotted.
@@ -609,7 +609,7 @@ def set_picker(self, p):
 
         Parameters
         ----------
-        p : float or callable[[Artist, Event], Tuple[bool, dict]]
+        p : float or callable[[Artist, Event], tuple[bool, dict]]
             If a float, it is used as the pick radius in points.
         """
         if callable(p):
diff --git a/lib/matplotlib/tight_layout.py b/lib/matplotlib/tight_layout.py
@@ -30,9 +30,9 @@ def auto_adjust_subplotpars(
 
     Parameters
     ----------
-    nrows_ncols : Tuple[int, int]
+    nrows_ncols : tuple[int, int]
         Number of rows and number of columns of the grid.
-    num1num2_list : List[int]
+    num1num2_list : list[int]
         List of numbers specifying the area occupied by the subplot
     subplot_list : list of subplots
         List of subplots that will be used to calculate optimal subplot_params.
@@ -42,7 +42,7 @@ def auto_adjust_subplotpars(
     h_pad, w_pad : float
         Padding (height/width) between edges of adjacent subplots, as a
         fraction of the font size.  Defaults to *pad*.
-    rect : Tuple[float, float, float, float]
+    rect : tuple[float, float, float, float]
         [left, bottom, right, top] in normalized (0, 1) figure coordinates.
     """
     rows, cols = nrows_ncols
@@ -237,7 +237,7 @@ def get_tight_layout_figure(fig, axes_list, subplotspec_list, renderer,
     h_pad, w_pad : float
         Padding (height/width) between edges of adjacent subplots.  Defaults to
         *pad*.
-    rect : Tuple[float, float, float, float], optional
+    rect : tuple[float, float, float, float], optional
         (left, bottom, right, top) rectangle in normalized figure coordinates
         that the whole subplots area (including labels) will fit into.
         Defaults to using the entire figure.
@@ -247,7 +247,6 @@ def get_tight_layout_figure(fig, axes_list, subplotspec_list, renderer,
     subplotspec or None
         subplotspec kwargs to be passed to `.Figure.subplots_adjust` or
         None if tight_layout could not be accomplished.
-
     """
 
     subplot_list = []
diff --git a/lib/matplotlib/type1font.py b/lib/matplotlib/type1font.py
@@ -46,10 +46,8 @@ class Type1Font:
     parts : tuple
         A 3-tuple of the cleartext part, the encrypted part, and the finale of
         zeros.
-
-    prop : Dict[str, Any]
+    prop : dict[str, Any]
         A dictionary of font properties.
-
     """
     __slots__ = ('parts', 'prop')
 
diff --git a/tutorials/provisional/mosaic.py b/tutorials/provisional/mosaic.py
@@ -46,15 +46,16 @@ def identify_axes(ax_dict, fontsize=48):
 
     Parameters
     ----------
-    ax_dict : Dict[str, Axes]
+    ax_dict : dict[str, Axes]
         Mapping between the title / label and the Axes.
-
     fontsize : int, optional
-        How big the label should be
+        How big the label should be.
     """
     kw = dict(ha="center", va="center", fontsize=fontsize, color="darkgrey")
     for k, ax in ax_dict.items():
         ax.text(0.5, 0.5, k, transform=ax.transAxes, **kw)
+
+
 ###############################################################################
 # If we want a 2x2 grid we can use `.Figure.subplots` which returns a 2D array
 # of `.axes.Axes` which we can index into to do our plotting.
