Make some more kwargs be more explicit in docstrings.

bingyao · bingyao · commit 87ff17cf8282 · 2019-07-11T13:19:59.000+08:00
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -920,12 +920,12 @@ def legend_elements(self, prop="colors", num="auto",
             the legend labels have the correct values;
             e.g. *func = np.exp(x, 10)*.
         kwargs : further parameters
-            Allowed kwargs are *color* and *size*. E.g. it may be useful to
-            set the color of the markers if *prop="sizes"* is used; similarly
-            to set the size of the markers if *prop="colors"* is used.
-            Any further parameters are passed onto the `.Line2D` instance.
-            This may be useful to e.g. specify a different *markeredgecolor* or
-            *alpha* for the legend handles.
+            Allowed keyword arguments are *color* and *size*. E.g. it may be
+            useful to set the color of the markers if *prop="sizes"* is used;
+            similarly to set the size of the markers if *prop="colors"* is
+            used. Any further parameters are passed onto the `.Line2D`
+            instance. This may be useful to e.g. specify a different
+            *markeredgecolor* or *alpha* for the legend handles.
 
         Returns
         -------
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -600,7 +600,7 @@ def __init__(self, patch, ox, oy, props=None, **kwargs):
         If *None*, the shadow will have have the same color as the face,
         but darkened.
 
-        kwargs are
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -682,7 +682,7 @@ def __init__(self, xy, width, height, angle=0.0, **kwargs):
 
         Notes
         -----
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -853,7 +853,7 @@ def __init__(self, xy, numVertices, radius=5, orientation=0,
         *orientation*
           rotates the polygon (in radians).
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -931,7 +931,7 @@ def __init__(self, path, **kwargs):
         """
         *path* is a :class:`matplotlib.path.Path` object.
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -958,7 +958,7 @@ def __init__(self, xy, closed=True, **kwargs):
         If *closed* is *True*, the polygon will be closed so the
         starting and ending points are the same.
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -1057,7 +1057,7 @@ def __init__(self, center, r, theta1, theta2, width=None, **kwargs):
         then a partial wedge is drawn from inner radius *r* - *width*
         to outer radius *r*.
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -1316,7 +1316,7 @@ def __init__(self, xy, radius=5,
         *resolution* sides.  For a smoother circle drawn with splines,
         see :class:`~matplotlib.patches.Circle`.
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -1353,7 +1353,7 @@ def __init__(self, xy, width, height, angle=0, **kwargs):
 
         Notes
         -----
-        Valid keyword arguments are
+        Valid keyword arguments are:
 
         %(Patch)s
         """
@@ -1431,7 +1431,7 @@ def __init__(self, xy, radius=5, **kwargs):
         which is a polygonal approximation, this uses Bezier splines
         and is much closer to a scale-free circle.
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
diff --git a/lib/matplotlib/spines.py b/lib/matplotlib/spines.py
@@ -38,7 +38,7 @@ def __init__(self, axes, spine_type, path, **kwargs):
         - *spine_type* : a string specifying the spine type
         - *path* : the path instance used to draw the spine
 
-        Valid kwargs are:
+        Valid keyword arguments are:
 
         %(Patch)s
         """
diff --git a/lib/matplotlib/table.py b/lib/matplotlib/table.py
@@ -171,7 +171,7 @@ def set_text_props(self, **kwargs):
         """
         Update the text properties.
 
-        Valid kwargs are
+        Valid keyword arguments are:
 
         %(Text)s
         """
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -135,7 +135,7 @@ def __init__(self,
         """
         Create a `.Text` instance at *x*, *y* with string *text*.
 
-        Valid kwargs are
+        Valid keyword arguments are:
 
         %(Text)s
         """
