Skip to content

Commit f852193

Browse files
committed
Make some more kwargs be more explicit in docstrings.
1 parent 9d5eeb5 commit f852193

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

lib/matplotlib/collections.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -919,12 +919,12 @@ def legend_elements(self, prop="colors", num="auto",
919919
the legend labels have the correct values;
920920
e.g. *func = np.exp(x, 10)*.
921921
kwargs : further parameters
922-
Allowed kwargs are *color* and *size*. E.g. it may be useful to
923-
set the color of the markers if *prop="sizes"* is used; similarly
924-
to set the size of the markers if *prop="colors"* is used.
925-
Any further parameters are passed onto the `.Line2D` instance.
926-
This may be useful to e.g. specify a different *markeredgecolor* or
927-
*alpha* for the legend handles.
922+
Allowed keyword arguments are *color* and *size*. E.g. it may be
923+
useful to set the color of the markers if *prop="sizes"* is used;
924+
similarly to set the size of the markers if *prop="colors"* is
925+
used. Any further parameters are passed onto the `.Line2D`
926+
instance. This may be useful to e.g. specify a different
927+
*markeredgecolor* or *alpha* for the legend handles.
928928
929929
Returns
930930
-------

lib/matplotlib/patches.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -600,7 +600,7 @@ def __init__(self, patch, ox, oy, props=None, **kwargs):
600600
If *None*, the shadow will have have the same color as the face,
601601
but darkened.
602602
603-
kwargs are
603+
Valid keyword arguments are:
604604
605605
%(Patch)s
606606
"""
@@ -682,7 +682,7 @@ def __init__(self, xy, width, height, angle=0.0, **kwargs):
682682
683683
Notes
684684
-----
685-
Valid kwargs are:
685+
Valid keyword arguments are:
686686
687687
%(Patch)s
688688
"""
@@ -853,7 +853,7 @@ def __init__(self, xy, numVertices, radius=5, orientation=0,
853853
*orientation*
854854
rotates the polygon (in radians).
855855
856-
Valid kwargs are:
856+
Valid keyword arguments are:
857857
858858
%(Patch)s
859859
"""
@@ -931,7 +931,7 @@ def __init__(self, path, **kwargs):
931931
"""
932932
*path* is a :class:`matplotlib.path.Path` object.
933933
934-
Valid kwargs are:
934+
Valid keyword arguments are:
935935
936936
%(Patch)s
937937
"""
@@ -961,7 +961,7 @@ def __init__(self, xy, closed=True, **kwargs):
961961
If *closed* is *True*, the polygon will be closed so the
962962
starting and ending points are the same.
963963
964-
Valid kwargs are:
964+
Valid keyword arguments are:
965965
966966
%(Patch)s
967967
"""
@@ -1060,7 +1060,7 @@ def __init__(self, center, r, theta1, theta2, width=None, **kwargs):
10601060
then a partial wedge is drawn from inner radius *r* - *width*
10611061
to outer radius *r*.
10621062
1063-
Valid kwargs are:
1063+
Valid keyword arguments are:
10641064
10651065
%(Patch)s
10661066
"""
@@ -1311,7 +1311,7 @@ def __init__(self, xy, radius=5,
13111311
*resolution* sides. For a smoother circle drawn with splines,
13121312
see :class:`~matplotlib.patches.Circle`.
13131313
1314-
Valid kwargs are:
1314+
Valid keyword arguments are:
13151315
13161316
%(Patch)s
13171317
"""
@@ -1348,7 +1348,7 @@ def __init__(self, xy, width, height, angle=0, **kwargs):
13481348
13491349
Notes
13501350
-----
1351-
Valid keyword arguments are
1351+
Valid keyword arguments are:
13521352
13531353
%(Patch)s
13541354
"""
@@ -1426,7 +1426,7 @@ def __init__(self, xy, radius=5, **kwargs):
14261426
which is a polygonal approximation, this uses Bezier splines
14271427
and is much closer to a scale-free circle.
14281428
1429-
Valid kwargs are:
1429+
Valid keyword arguments are:
14301430
14311431
%(Patch)s
14321432
"""

lib/matplotlib/spines.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def __init__(self, axes, spine_type, path, **kwargs):
3939
- *spine_type* : a string specifying the spine type
4040
- *path* : the path instance used to draw the spine
4141
42-
Valid kwargs are:
42+
Valid keyword arguments are:
4343
4444
%(Patch)s
4545
"""

lib/matplotlib/table.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def set_text_props(self, **kwargs):
171171
"""
172172
Update the text properties.
173173
174-
Valid kwargs are
174+
Valid keyword arguments are:
175175
176176
%(Text)s
177177
"""

lib/matplotlib/text.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ def __init__(self,
135135
"""
136136
Create a `.Text` instance at *x*, *y* with string *text*.
137137
138-
Valid kwargs are
138+
Valid keyword arguments are:
139139
140140
%(Text)s
141141
"""

0 commit comments

Comments
 (0)