DOCS: more @timhoffm's suggestions, collections.py

brunobeltran · brunobeltran · commit 8bbdf6805054 · 2020-06-05T19:35:01.000-07:00
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -30,27 +30,25 @@ class Collection(artist.Artist, cm.ScalarMappable):
     r"""
     Base class for Collections. Must be subclassed to be usable.
 
-    A Collection represents a sequence of `~.patches.Patch`\s that can be drawn
+    A Collection represents a sequence of `.Patch`\s that can be drawn
     more efficiently together than individually. For example, when a single
     path is being drawn repeatedly at different offsets, the renderer can
     typically execute a ``draw_marker()`` call much more efficiently than a
     series of repeated calls to ``draw_path()`` with the offsets put in
     one-by-one.
 
     Most properties of a collection can be configured per-element. Therefore,
-    Collections have "plural" versions of many of the properties of a
-    `~.patches.Patch` (e.g. `.Collection.get_paths` instead of
-    `~.patches.Patch.get_path`). Exceptions are the *zorder*, *hatch*,
-    *pickradius*, *capstyle* and *joinstyle* properties, which can only be set
-    globally for the whole collection.
+    Collections have "plural" versions of many of the properties of a `.Patch`
+    (e.g. `.Collection.get_paths` instead of `.Patch.get_path`). Exceptions are
+    the *zorder*, *hatch*, *pickradius*, *capstyle* and *joinstyle* properties,
+    which can only be set globally for the whole collection.
 
     Besides these exceptions, all properties can be specified as single values
     (applying to all elements) or sequences of values. The property of the
-    ``i``th element of the collection is::
+    ``i``\th element of the collection is::
 
       prop[i % len(prop)]
 
-
     Each Collection can optionally be used as its own `~.cm.ScalarMappable` by
     passing the *norm* and *cmap* parameters to its constructor. If the
     Collection's `~.cm.ScalarMappable` matrix ``_A`` has been set (via a call
@@ -129,15 +127,15 @@ def __init__(self,
         offset_position : {'screen' (default), 'data' (deprecated)}
             If set to 'data' (deprecated), *offsets* will be treated as if it
             is in data coordinates instead of in screen coordinates.
-        norm : `~.colors.Normalize`, optional, default: None
+        norm : `~.colors.Normalize`, optional
             Forwarded to `~.cm.ScalarMappable`. The default of
             ``None`` means that the first draw call will set ``vmin`` and
             ``vmax`` using the minimum and maximum values of the data.
-        cmap : `~.colors.Colormap`, optional, default: None
+        cmap : `~.colors.Colormap`, optional
             Forwarded to `~.cm.ScalarMappable`. The default of
             ``None`` will result in :rc:`image.cmap` being used.
-        hatch : str, optional, default: None
-            Hatching pattern to use in filled paths, if any.  Valid strings are
+        hatch : str, optional
+            Hatching pattern to use in filled paths, if any. Valid strings are
             ['/', '\\', '|', '-', '+', 'x', 'o', 'O', '.', '*']. See
             :doc:`/gallery/shapes_and_collections/hatch_demo` for the meaning
             of each hatch type.
@@ -148,7 +146,7 @@ def __init__(self,
             other hand, if it is greater than 0, then we instead check if the
             test point is contained in a stroke of width ``2*pickradius``
             following any of the Paths in the Collection.
-        urls : list of str, optional, default: None
+        urls : list of str, default: None
             A URL for each patch to link to once drawn. Currently only works
             for the SVG backend. See :doc:`/gallery/misc/hyperlinks_sgskip` for
             examples.
@@ -468,7 +466,7 @@ def set_urls(self, urls):
         """
         Parameters
         ----------
-        urls : sequence of str or None
+        urls : list of str or None
 
         Notes
         -----
@@ -726,7 +724,7 @@ def set_antialiased(self, aa):
 
         Parameters
         ----------
-        aa : bool or sequence of bools
+        aa : bool or list of bools
         """
         if aa is None:
             aa = mpl.rcParams['patch.antialiased']
@@ -739,7 +737,7 @@ def set_color(self, c):
 
         Parameters
         ----------
-        c : color or sequence of rgba tuples
+        c : color or list of rgba tuples
 
         See Also
         --------
@@ -772,7 +770,7 @@ def set_facecolor(self, c):
 
         Parameters
         ----------
-        c : color or sequence of colors
+        c : color or list of colors
         """
         self._original_facecolor = c
         self._set_facecolor(c)
@@ -820,7 +818,7 @@ def set_edgecolor(self, c):
 
         Parameters
         ----------
-        c : color or sequence of colors or 'face'
+        c : color or list of colors or 'face'
             The collection edgecolor(s).  If a sequence, the patches cycle
             through it.  If 'face', match the facecolor.
         """
@@ -938,9 +936,9 @@ def __init__(self, paths, sizes=None, **kwargs):
         """
         Parameters
         ----------
-        paths : list of matplotlib.path.Path
+        paths : list of `.path.Path`
             The paths that will make up the `.Collection`.
-        sizes : array-like of float
+        sizes : array-like
             The factor by which to scale each drawn `~.path.Path`. One unit
             squared in the Path's data space is scaled to be ``sizes**2``
             points when rendered.
@@ -1102,11 +1100,11 @@ def __init__(self, verts, sizes=None, closed=True, **kwargs):
         """
         Parameters
         ----------
-        verts : sequence of array-like
+        verts : list of array-like
             The sequence of polygons [*verts0*, *verts1*, ...] where each
             element *verts_i* defines the vertices of polygon *i* as a 2D
             array-like of of shape (M, 2).
-        sizes : array-like of float, default: None
+        sizes : array-like, default: None
             Squared scaling factors for the polygons. The coordinates of each
             polygon *verts_i* are multiplied by the square-root of the
             corresponding entry in *sizes* (i.e., *sizes* specify the scaling
@@ -1129,7 +1127,7 @@ def set_verts(self, verts, closed=True):
 
         Parameters
         ----------
-        verts : sequence
+        verts : list of array-like
             The sequence of polygons [*verts0*, *verts1*, ...] where each
             element *verts_i* defines the vertices of polygon *i* as a 2D
             array-like of of shape (M, 2).
@@ -1194,7 +1192,7 @@ def __init__(self, xranges, yrange, **kwargs):
         """
         Parameters
         ----------
-        xranges : sequence of (float, float)
+        xranges : list of (float, float)
             The sequence of (left-edge-position, width) pairs for each bar.
         yrange : (float, float)
             The (lower-edge, height) common to all bars.
@@ -1315,7 +1313,7 @@ class LineCollection(Collection):
       prop[i % len(prop)]
 
     A *LineCollection*'s properties default to their ``'lines'`` values in
-    `~.matplotlib.rcParams` instead of their ``'patch'`` values, and the
+    `~.rcParams` instead of their ``'patch'`` values, and the
     property *colors* is added in place of *edgecolors*.
     """
 
@@ -1338,7 +1336,7 @@ def __init__(self, segments,     # Can be None.
         """
         Parameters
         ----------
-        segments: sequence of array-like
+        segments: list of array-like
             A sequence of (*line0*, *line1*, *line2*), where::
 
                 linen = (x0, y0), (x1, y1), ... (xm, ym)
@@ -1669,7 +1667,7 @@ def __init__(self, sizes, **kwargs):
         Parameters
         ----------
         sizes : float or array-like
-            Gives the area of each circle in points^2.
+            The area of each circle in points^2.
         **kwargs
             Forwarded to `.Collection`.
         """
