8000 Merge pull request #24521 from oscargus/mplspelling · matplotlib/matplotlib@c1013ad · GitHub
[go: up one dir, main page]

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c1013ad

Browse files
authored
Merge pull request #24521 from oscargus/mplspelling
Doc: improve spelling and grammar
2 parents 2f4c02d + f3e2e8e commit c1013ad

File tree

9 files changed

+27
-30
lines changed

9 files changed

+27
-30
lines changed

lib/mpl_toolkits/axes_grid1/anchored_artists.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self, width, height, xdescent, ydescent,
3030
Location of this artist. Valid locations are
3131
'upper left', 'upper center', 'upper right',
3232
'center left', 'center', 'center right',
33-
'lower left', 'lower center, 'lower right'.
33+
'lower left', 'lower center', 'lower right'.
3434
For backward compatibility, numeric values are accepted as well.
3535
See the parameter *loc* of `.Legend` for details.
3636
pad : float, default: 0.4
@@ -88,7 +88,7 @@ def __init__(self, transform, loc,
8888
Location of this artist. Valid locations are
8989
'upper left', 'upper center', 'upper right',
9090
'center left', 'center', 'center right',
91-
'lower left', 'lower center, 'lower right'.
91+
'lower left', 'lower center', 'lower right'.
9292
For backward compatibility, numeric values are accepted as well.
9393
See the parameter *loc* of `.Legend` for details.
9494
pad : float, default: 0.4
@@ -144,7 +144,7 @@ def __init__(self, transform, width, height, angle, loc,
144144
Location of the ellipse. Valid locations are
145145
'upper left', 'upper center', 'upper right',
146146
'center left', 'center', 'center right',
147-
'lower left', 'lower center, 'lower right'.
147+
'lower left', 'lower center', 'lower right'.
148148
For backward compatibility, numeric values are accepted as well.
149149
See the parameter *loc* of `.Legend` for details.
150150
pad : float, default: 0.1
@@ -194,7 +194,7 @@ def __init__(self, transform, size, label, loc,
194194
Location of the size bar. Valid locations are
195195
'upper left', 'upper center', 'upper right',
196196
'center left', 'center', 'center right',
197-
'lower left', 'lower center, 'lower right'.
197+
'lower left', 'lower center', 'lower right'.
198198
For backward compatibility, numeric values are accepted as well.
199199
See the parameter *loc* of `.Legend` for details.
200200
pad : float, default: 0.1
@@ -314,7 +314,7 @@ def __init__(self, transform, label_x, label_y, length=0.15,
314314
Location of the arrow. Valid locations are
315315
'upper left', 'upper center', 'upper right',
316316
'center left', 'center', 'center right',
317-
'lower left', 'lower center, 'lower right'.
317+
'lower left', 'lower center', 'lower right'.
318318
For backward compatibility, numeric values are accepted as well.
319319
See the parameter *loc* of `.Legend` for details.
320320
angle : float, default: 0

lib/mpl_toolkits/axes_grid1/axes_divider.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,10 +167,10 @@ def locate(self, nx, ny, nx1=None, ny1=None, axes=None, renderer=None):
167167
Parameters
168168
----------
169169
nx, nx1 : int
170-
Integers specifying the column-position of the
171-
cell. When *nx1* is None, a single *nx*-th column is
172-
specified. Otherwise location of columns spanning between *nx*
173-
to *nx1* (but excluding *nx1*-th column) is specified.
170+
Integers specifying the column-position of the cell. When *nx1* is
171+
None, a single *nx*-th column is specified. Otherwise, the
172+
location of columns spanning between *nx* to *nx1* (but excluding
173+
*nx1*-th column) is specified.
174174
ny, ny1 : int
175175
Same as *nx* and *nx1*, but for row positions.
176176
axes
@@ -486,8 +486,8 @@ def append_axes(self, position, size, pad=None, *, axes_class=None,
486486
pad : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str
487487
Padding between the axes. float or str arguments are interpreted
488488
as for *size*. Defaults to :rc:`figure.subplot.wspace` times the
489-
main axes width (left or right axes) or :rc:`figure.subplot.hspace`
490-
times the main axes height (bottom or top axes).
489+
main Axes width (left or right axes) or :rc:`figure.subplot.hspace`
490+
times the main Axes height (bottom or top axes).
491491
axes_class : subclass type of `~.axes.Axes`, optional
492492
The type of the new axes. Defaults to the type of the main axes.
493493
**kwargs

lib/mpl_toolkits/axes_grid1/axes_grid.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class Grid:
4848
"""
4949
A grid of Axes.
5050
51-
In Matplotlib, the axes location (and size) is specified in normalized
51+
In Matplotlib, the Axes location (and size) is specified in normalized
5252
figure coordinates. This may not be ideal for images that needs to be
5353
displayed with a given aspect ratio; for example, it is difficult to
5454
display multiple images of a same size with some fixed padding between

lib/mpl_toolkits/axes_grid1/axes_size.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
"""
22
Provides classes of simple units that will be used with AxesDivider
3-
class (or others) to determine the size of each axes. The unit
3+
class (or others) to determine the size of each Axes. The unit
44
classes define `get_size` method that returns a tuple of two floats,
55
meaning relative and absolute sizes, respectively.
66
@@ -207,7 +207,7 @@ def get_size(self, renderer):
207207
@_api.deprecated("3.6", alternative="size + pad")
208208
class Padded(_Base):
209209
"""
210-
Return a instance where the absolute part of *size* is
210+
Return an instance where the absolute part of *size* is
211211
increase by the amount of *pad*.
212212
"""
213213

lib/mpl_toolkits/axes_grid1/inset_locator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ def inset_axes(parent_axes, width, height, loc='upper right',
342342
Location to place the inset axes. Valid locations are
343343
'upper left', 'upper center', 'upper right',
344344
'center left', 'center', 'center right',
345-
'lower left', 'lower center, 'lower right'.
345+
'lower left', 'lower center', 'lower right'.
346346
For backward compatibility, numeric values are accepted as well.
347347
See the parameter *loc* of `.Legend` for details.
348348
@@ -450,7 +450,7 @@ def zoomed_inset_axes(parent_axes, zoom, loc='upper right',
450450
Location to place the inset axes. Valid locations are
451451
'upper left', 'upper center', 'upper right',
452452
'center left', 'center', 'center right',
453-
'lower left', 'lower center, 'lower right'.
453+
'lower left', 'lower center', 'lower right'.
454454
For backward compatibility, numeric values are accepted as well.
455455
See the parameter *loc* of `.Legend` for details.
456456

lib/mpl_toolkits/axisartist/axisline_style.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ class AxislineStyle(_Style):
7575
"""
7676
A container class which defines style classes for AxisArtists.
7777
78-
An instance of any axisline style class is an callable object,
78+
An instance of any axisline style class is a callable object,
7979
whose call signature is ::
8080
8181
__call__(self, axis_artist, path, transform)

lib/mpl_toolkits/axisartist/grid_finder.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ def __init__(self,
130130
tick_formatter2=None):
131131
"""
132132
transform : transform from the image coordinate (which will be
133-
the transData of the axes to the world coordinate.
133+
the transData of the axes to the world coordinate).
134134
135135
or transform = (transform_xy, inv_transform_xy)
136136

lib/mpl_toolkits/mplot3d/art3d.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -514,10 +514,9 @@ def __init__(self, *args, zs=0, zdir='z', depthshade=True, **kwargs):
514514
:class:`~matplotlib.collections.PatchCollection`. In addition,
515515
keywords *zs=0* and *zdir='z'* are available.
516516
517-
Also, the keyword argument *depthshade* is available to
518-
indicate whether or not to shade the patches in order to
519-
give the appearance of depth (default is *True*).
520-
This is typically desired in scatter plots.
517+
Also, the keyword argument *depthshade* is available to indicate
518+
whether to shade the patches in order to give the appearance of depth
519+
(default is *True*). This is typically desired in scatter plots.
521520
"""
522521
self._depthshade = depthshade
523522
super().__init__(*args, **kwargs)
@@ -622,10 +621,9 @@ def __init__(self, *args, zs=0, zdir='z', depthshade=True, **kwargs):
622621
:class:`~matplotlib.collections.PathCollection`. In addition,
623622
keywords *zs=0* and *zdir='z'* are available.
624623
625-
Also, the keyword argument *depthshade* is available to
626-
indicate whether or not to shade the patches in order to
627-
give the appearance of depth (default is *True*).
628-
This is typically desired in scatter plots.
624+
Also, the keyword argument *depthshade* is available to indicate
625+
whether to shade the patches in order to give the appearance of depth
626+
(default is *True*). This is typically desired in scatter plots.
629627
"""
630628
self._depthshade = depthshade
631629
self._in_draw = False

lib/mpl_toolkits/mplot3d/axes3d.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2349,7 +2349,7 @@ def bar3d(self, x, y, z, dx, dy, dz, color=None,
23492349
"""
23502350
Generate a 3D barplot.
23512351
2352-
This method creates three dimensional barplot where the width,
2352+
This method creates three-dimensional barplot where the width,
23532353
depth, height, and color of the bars can all be uniquely set.
23542354
23552355
Parameters
@@ -2402,8 +2402,7 @@ def bar3d(self, x, y, z, dx, dy, dz, color=None,
24022402
Returns
24032403
-------
24042404
collection : `~.art3d.Poly3DCollection`
2405-
A collection of three dimensional polygons representing
2406-
the bars.
2405+
A collection of three-dimensional polygons representing the bars.
24072406
"""
24082407

24092408
had_data = self.has_data()
@@ -2908,7 +2907,7 @@ def errorbar(self, x, y, z, zerr=None, yerr=None, xerr=None, fmt='',
29082907
The format for the data points / data lines. See `.plot` for
29092908
details.
29102909
2911-
Use 'none' (case insensitive) to plot errorbars without any data
2910+
Use 'none' (case-insensitive) to plot errorbars without any data
29122911
markers.
29132912
29142913
ecolor : color, default: None

0 commit comments

Comments
 (0)
0