Skip to content

Commit c6328b1

Browse files
committed
DOC: fix incorrect parameter name.
Also uniformise indent of one section to match the rest of the file
1 parent 9d12377 commit c6328b1

File tree

5 files changed

+19
-17
lines changed

5 files changed

+19
-17
lines changed

lib/matplotlib/backend_bases.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,7 +1065,7 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
10651065
pixels. If scale is `None`, or not provided, no sketch filter will
10661066
be provided.
10671067
length : float, default: 128
1068-
The length of the wiggle along the line, in pixels.
1068+
The length of the wiggle along the line, in pixels.
10691069
randomness : float, default: 16
10701070
The scale factor by which the length is shrunken or expanded.
10711071
"""
@@ -3420,7 +3420,7 @@ def add_toolitem(self, name, group, position, image, description, toggle):
34203420
Name of the group that this tool belongs to.
34213421
position : int
34223422
Position of the tool within its group, if -1 it goes at the end.
3423-
image_file : str
3423+
image : str
34243424
Filename of the image for the button or `None`.
34253425
description : str
34263426
Description of the tool, used for the tooltips.

lib/matplotlib/backend_managers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ def update_keymap(self, name, key, *args):
191191
----------
192192
name : str
193193
Name of the Tool.
194-
keys : str or list of str
194+
key : str or list of str
195195
Keys to associate with the tool.
196196
"""
197197
if name not in self._tools:

lib/matplotlib/collections.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@ def set_pickradius(self, pr):
421421
422422
Parameters
423423
----------
424-
d : float
424+
pr : float
425425
Pick radius, in points.
426426
"""
427427
self._pickradius = pr
@@ -705,7 +705,7 @@ def _bcast_lwls(linewidths, dashes):
705705
Returns
706706
-------
707707
linewidths, dashes : list
708-
Will be the same length, dashes are scaled by paired linewidth
708+
Will be the same length, dashes are scaled by paired linewidth
709709
"""
710710
if mpl.rcParams['_internal.classic_mode']:
711711
return linewidths, dashes
@@ -1384,15 +1384,17 @@ def __init__(self, segments, # Can be None.
13841384
antialiaseds : bool or list of bool, default: :rc:`lines.antialiased`
13851385
Whether to use antialiasing for each line.
13861386
zorder : int, default: 2
1387-
zorder of the lines once drawn.
1387+
zorder of the lines once drawn.
1388+
13881389
facecolors : color or list of color, default: 'none'
1389-
When setting *facecolors*, each line is interpreted as a boundary
1390-
for an area, implicitly closing the path from the last point to the
1391-
first point. The enclosed area is filled with *facecolor*.
1392-
In order to manually specify what should count as the "interior" of
1393-
each line, please use `.PathCollection` instead, where the
1394-
"interior" can be specified by appropriate usage of
1395-
`~.path.Path.CLOSEPOLY`.
1390+
When setting *facecolors*, each line is interpreted as a boundary
1391+
for an area, implicitly closing the path from the last point to the
1392+
first point. The enclosed area is filled with *facecolor*.
1393+
In order to manually specify what should count as the "interior" of
1394+
each line, please use `.PathCollection` instead, where the
1395+
"interior" can be specified by appropriate usage of
1396+
`~.path.Path.CLOSEPOLY`.
1397+
13961398
**kwargs
13971399
Forwareded to `.Collection`.
13981400
"""

lib/matplotlib/tri/triinterpolate.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ def _interpolate_single_key(self, return_key, tri_index, x, y):
213213
214214
Parameters
215215
----------
216-
return_index : {'z', 'dzdx', 'dzdy'}
216+
return_key : {'z', 'dzdx', 'dzdy'}
217217
Identifies the requested values (z or its derivatives)
218218
tri_index : 1D int array
219219
Valid triangle index (-1 prohibited)
@@ -461,8 +461,8 @@ def _compute_dof(self, kind, dz=None):
461461
Returns
462462
-------
463463
array-like, shape (npts, 2)
464-
Estimation of the gradient at triangulation nodes (stored as
465-
degree of freedoms of reduced-HCT triangle elements).
464+
Estimation of the gradient at triangulation nodes (stored as
465+
degree of freedoms of reduced-HCT triangle elements).
466466
"""
467467
if kind == 'user':
468468
if dz is None:

lib/mpl_toolkits/axisartist/axis_artist.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -759,7 +759,7 @@ def set_axislabel_direction(self, label_direction):
759759
760760
Parameters
761761
----------
762-
tick_direction : {"+", "-"}
762+
label_direction : {"+", "-"}
763763
"""
764764
self._axislabel_add_angle = _api.check_getitem(
765765
{"+": 0, "-": 180}, label_direction=label_direction)

0 commit comments

Comments
 (0)