Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0291369

Browse files
committed
[DOC] fixed lots of typos in mpl_toolkits
svn path=/trunk/matplotlib/; revision=8925
1 parent 6938b00 commit 0291369

25 files changed

+141
-137
lines changed

doc/mpl_toolkits/axes_grid/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ multiple axes according to their aspects.
1818
0.99. Originally, the toolkit had a single namespace of
1919
*axes_grid*. In more recent version (since svn r8226), the toolkit
2020
has divided into two separate namespace (*axes_grid1* and *axisartist*).
21-
While *axes_grid* namespace is maintained for he backward compatibility,
21+
While *axes_grid* namespace is maintained for the backward compatibility,
2222
use of *axes_grid1* and *axisartist* is recommended.
2323

2424
.. warning::
2525
*axes_grid* and *axisartist* (but not *axes_grid1*) uses
26-
a custome Axes class (derived from the mpl's original Axes class).
27-
As a sideeffect, some commands (mostly tick-related) do not work.
26+
a custom Axes class (derived from the mpl's original Axes class).
27+
As a side effect, some commands (mostly tick-related) do not work.
2828
Use *axes_grid1* to avoid this, or see how things are different in
2929
*axes_grid* and *axisartist* (LINK needed)
3030

doc/mpl_toolkits/axes_grid/users/axes_divider.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ AxesDivider
44
The axes_divider module provide helper classes to adjust the axes
55
positions of set of images in the drawing time.
66

7-
* :mod:`~mpl_toolkits.axes_grid.axes_size` provides a classese of
7+
* :mod:`~mpl_toolkits.axes_grid.axes_size` provides a classes of
88
units that the size of each axes will be determined. For example,
99
you can specify a fixed size
1010

1111
* :class:`~mpl_toolkits.axes_grid.axes_size.Divider` this is the class
1212
that is used calculates the axes position. It divides the given
13-
renctangular area into several areas. You intialize the divider by
13+
rectangular area into several areas. You initialize the divider by
1414
setting the horizontal and vertical list of sizes that the division
1515
will be based on. You then use the new_locator method, whose return
1616
value is a callable object that can be used to set the axes_locator
1717
of the axes.
1818

1919

20-
You first initialize the divider by specifying its grids, i.e., horiz and vert.
20+
You first initialize the divider by specifying its grids, i.e.,
21+
horizontal and vertical.
2122

2223
for example,::
2324

@@ -56,8 +57,8 @@ be adjusted accordingly.
5657

5758

5859
The :mod:`mpl_toolkits.axes_grid.axes_size` contains several classes
59-
that can be used to set the horiz and vert. For example, for the
60-
vertical configuration above will be::
60+
that can be used to set the horizontal and vertical configurations. For
61+
example, for the vertical configuration above will be::
6162

6263
from mpl_toolkits.axes_grid.axes_size import Fixed, Scaled
6364
vert = [Fixed(2), Scaled(2), Scaled(3)]
@@ -84,7 +85,7 @@ See the example,
8485
.. plot:: mpl_toolkits/axes_grid/figures/simple_axes_divider2.py
8586
:include-source:
8687

87-
You can adjust the size of the each axes accroding to their x or y
88+
You can adjust the size of the each axes according to their x or y
8889
data limits (AxesX and AxesY), similar to the axes aspect parameter.
8990

9091
.. plot:: mpl_toolkits/axes_grid/figures/simple_axes_divider3.py

doc/mpl_toolkits/axes_grid/users/axisartist.rst

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
AXISARTIST namespace
55
====================
66

7-
The AxisArtist namesapce includes a derived Axes implementation. The
7+
The AxisArtist namespace includes a derived Axes implementation. The
88
biggest difference is that the artists responsible to draw axis line,
99
ticks, ticklabel and axis labels are separated out from the mpl's Axis
1010
class, which are much more than artists in the original mpl. This
11-
change was strongly motivated to support curvlinear grid. Here are a
11+
change was strongly motivated to support curvilinear grid. Here are a
1212
few things that mpl_tootlkits.axisartist.Axes is different from original
1313
Axes from mpl.
1414

@@ -18,15 +18,15 @@ Axes from mpl.
1818
have different tick location and different tick labels.
1919

2020
* gridlines are drawn by a Gridlines instance. The change was
21-
motivated that in curvelinear coordinate, a gridline may not cross
21+
motivated that in curvilinear coordinate, a gridline may not cross
2222
axis-lines (i.e., no associated ticks). In the original Axes class,
2323
gridlines are tied to ticks.
2424

2525
* ticklines can be rotated if necessary (i.e, along the gridlines)
2626

2727
In summary, all these changes was to support
2828

29-
* a curvelinear grid.
29+
* a curvilinear grid.
3030
* a floating axis
3131

3232
.. plot:: mpl_toolkits/axes_grid/examples/demo_floating_axis.py
@@ -111,7 +111,8 @@ Similarly, to make ticklabels invisible ::
111111

112112
ax.axis["bottom"].major_ticklabels.set_visible(False)
113113

114-
AxisAritst provides a helper method to control the visibility of ticks, ticklabels, and label. To make ticklabel invisible, ::
114+
AxisAritst provides a helper method to control the visibility of ticks,
115+
ticklabels, and label. To make ticklabel invisible, ::
115116

116117
ax.axis["bottom"].toggle(ticklabels=False)
117118

@@ -138,7 +139,7 @@ Note that 'ax.axis["top","right"]' returns a simple proxy object that translate
138139
for n in ["top","right"]:
139140
ax.axis[n].toggle(ticklabels=True))
140141

141-
So, any return values in the for loop are ignored. And you shoud not
142+
So, any return values in the for loop are ignored. And you should not
142143
use it anything more than a simple method.
143144

144145
Like the list indexing ":" means all items, i.e., ::
@@ -184,8 +185,8 @@ HowTo
184185
axis.label.set_pad method.
185186

186187

187-
Rotaion and Alignment of TickLabels
188-
===================================
188+
Rotation and Alignment of TickLabels
189+
====================================
189190

190191
This is also quite different from the original mpl and can be
191192
confusing. When you want to rotate the ticklabels, first consider
@@ -252,7 +253,7 @@ direction can be more clear with curved axis.
252253

253254
.. plot:: mpl_toolkits/axes_grid/figures/demo_axis_direction.py
254255

255-
The axis_drection can be adjusted in the AxisArtist level, or in the
256+
The axis_direction can be adjusted in the AxisArtist level, or in the
256257
level of its child arists, i.e., ticks, ticklabels, and axis-label. ::
257258

258259
ax1.axis["left"].set_axis_direction("top")
@@ -264,7 +265,7 @@ axis, while ::
264265

265266
changes the axis_direction of only the major_ticklabels. Note that
266267
set_axis_direction in the AxisArtist level changes the
267-
ticklabel_direction and label_direction, while chainging the
268+
ticklabel_direction and label_direction, while changing the
268269
axis_direction of ticks, ticklabels, and axis-label does not affect
269270
them.
270271

@@ -295,11 +296,11 @@ So, in summary,
295296
* set_ticksize : size in points
296297
* TickLabels' methods (major_ticklabels and minor_ticklabels)
297298
* set_axis_direction : "left", "right", "bottom", or "top"
298-
* set_rotation : angle with respect to the renference direction
299+
* set_rotation : angle with respect to the reference direction
299300
* set_ha and set_va : see below
300301
* AxisLabels' methods (label)
301302
* set_axis_direction : "left", "right", "bottom", or "top"
302-
* set_rotation : angle with respect to the renference direction
303+
* set_rotation : angle with respect to the reference direction
303304
* set_ha and set_va
304305

305306

@@ -329,13 +330,13 @@ Or ticklabels and axis-label ::
329330
GridHelper
330331
==========
331332

332-
To actually define a curvelinear coordinate, you have to use your own
333+
To actually define a curvilinear coordinate, you have to use your own
333334
grid helper. A generalised version of grid helper class is supplied
334335
and this class should suffice in most of cases. A user may provide
335336
two functions which defines a transformation (and its inverse pair)
336-
from the curved coordinate to (rectlinear) image coordinate. Note that
337+
from the curved coordinate to (rectilinear) image coordinate. Note that
337338
while ticks and grids are drawn for curved coordinate, the data
338-
transform of the axes itself (ax.transData) is still rectlinear
339+
transform of the axes itself (ax.transData) is still rectilinear
339340
(image) coordinate. ::
340341

341342

@@ -404,7 +405,7 @@ required. ::
404405
)
405406

406407

407-
Again, the *transData* of the axes is still a rectlinear coordinate
408+
Again, the *transData* of the axes is still a rectilinear coordinate
408409
(image coordinate). You may manually do conversion between two
409410
coordinates, or you may use Parasite Axes for convenience.::
410411

@@ -447,7 +448,7 @@ Current Limitations and TODO's
447448
The code need more refinement. Here is a incomplete list of issues and TODO's
448449

449450
* No easy way to support a user customized tick location (for
450-
curvelinear grid). A new Locator class needs to be created.
451+
curvilinear grid). A new Locator class needs to be created.
451452

452453
* FloatingAxis may have coordinate limits, e.g., a floating axis of x
453454
= 0, but y only spans from 0 to 1.

doc/mpl_toolkits/axes_grid/users/overview.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ mainly to ease displaying (multiple) images in matplotlib.
1717
0.99. Originally, the toolkit had a single namespace of
1818
*axes_grid*. In more recent version (since svn r8226), the toolkit
1919
has divided into two separate namespace (*axes_grid1* and *axisartist*).
20-
While *axes_grid* namespace is maintained for he backward compatibility,
20+
While *axes_grid* namespace is maintained for the backward compatibility,
2121
use of *axes_grid1* and *axisartist* is recommended.
2222

2323
.. warning::
2424
*axes_grid* and *axisartist* (but not *axes_grid1*) uses
25-
a custome Axes class (derived from the mpl's original Axes class).
26-
As a sideeffect, some commands (mostly tick-related) do not work.
25+
a custom Axes class (derived from the mpl's original Axes class).
26+
As a side effect, some commands (mostly tick-related) do not work.
2727
Use *axes_grid1* to avoid this, or see how things are different in
2828
*axes_grid* and *axisartist* (LINK needed)
2929

3030

3131
AxesGrid toolkit has two namespaces (*axes_grid1* and *axisartist*).
32-
*axisartist* contains custome Axes class that is meant to support for
32+
*axisartist* contains custom Axes class that is meant to support for
3333
curvilinear grids (e.g., the world coordinate system in astronomy).
3434
Unlike mpl's original Axes class which uses Axes.xaxis and Axes.yaxis
3535
to draw ticks, ticklines and etc., Axes in axisartist uses special
@@ -46,7 +46,7 @@ Axes.xaxis and Axes.yaxis may not work. See LINK for more detail.
4646
(multiple) images with matplotlib. In matplotlib, the axes location
4747
(and size) is specified in the normalized figure coordinates, which
4848
may not be ideal for displaying images that needs to have a given
49-
aspect ratio. For example, it helps you to have a colobar whose
49+
aspect ratio. For example, it helps you to have a colorbar whose
5050
height always matches that of the image. `ImageGrid`_, `RGB Axes`_ and
5151
`AxesDivider`_ are helper classes that deals with adjusting the
5252
location of (multiple) Axes. They provides a framework to adjust the
@@ -76,9 +76,9 @@ used in such case.
7676
.. plot:: mpl_toolkits/axes_grid/examples/simple_axesgrid.py
7777
:include-source:
7878

79-
* The postion of each axes is determined at the drawing time (see
79+
* The position of each axes is determined at the drawing time (see
8080
`AxesDivider`_), so that the size of the entire grid fits in the
81-
given rectangle (like the aspec of axes). Note that in this example,
81+
given rectangle (like the aspect of axes). Note that in this example,
8282
the paddings between axes are fixed even if you changes the figure
8383
size.
8484

@@ -141,7 +141,7 @@ AxesGrid takes following arguments,
141141
means the increasing direction of the axes number.
142142

143143
*aspect*
144-
By default (False), widths and heigths of axes in the grid are
144+
By default (False), widths and heights of axes in the grid are
145145
scaled independently. If True, they are scaled according to their
146146
data limits (similar to aspect parameter in mpl).
147147

@@ -165,7 +165,7 @@ AxesGrid takes following arguments,
165165
| grid[1] | grid[3] |
166166
+---------+---------+
167167

168-
You can also create a colorbar (or colobars). You can have colorbar
168+
You can also create a colorbar (or colorbars). You can have colorbar
169169
for each axes (cbar_mode="each"), or you can have a single colorbar
170170
for the grid (cbar_mode="single"). The colorbar can be placed on your
171171
right, or top. The axes for each colorbar is stored as a *cbar_axes*
@@ -187,7 +187,7 @@ at drawing time. While a more about the AxesDivider is (will be)
187187
explained in (yet to be written) AxesDividerGuide, direct use of the
188188
AxesDivider class will not be necessary for most users. The
189189
axes_divider module provides a helper function make_axes_locatable,
190-
which can be useful. It takes a exisitng axes instance and create a
190+
which can be useful. It takes a existing axes instance and create a
191191
divider for it. ::
192192

193193
ax = subplot(1,1,1)
@@ -196,7 +196,7 @@ divider for it. ::
196196

197197

198198

199-
*make_axes_locatable* returns an isntance of the AxesLocator class,
199+
*make_axes_locatable* returns an instance of the AxesLocator class,
200200
derived from the Locator. It provides *append_axes* method that
201201
creates a new axes on the given side of ("top", "right", "bottom" and
202202
"left") of the original axes.
@@ -255,7 +255,7 @@ if the host change its location (e.g., images).
255255
In most cases, you first create a host axes, which provides a few
256256
method that can be used to create parasite axes. They are *twinx*,
257257
*twiny* (which are similar to twinx and twiny in the matplotlib) and
258-
*twin*. *twin* takes an arbitraty tranfromation that maps between the
258+
*twin*. *twin* takes an arbitrary transformation that maps between the
259259
data coordinates of the host axes and the parasite axes. *draw*
260260
method of the parasite axes are never called. Instead, host axes
261261
collects artists in parasite axes and draw them as if they belong to
@@ -292,7 +292,7 @@ tick-formatter for bottom(or left)-axis. ::
292292

293293

294294

295-
A more sophiscated example using twin. Note that if you change the
295+
A more sophisticated example using twin. Note that if you change the
296296
x-limit in the host axes, the x-limit of the parasite axes will change
297297
accordingly.
298298

@@ -319,7 +319,7 @@ InsetLocator
319319

320320
:mod:`mpl_toolkits.axes_grid.inset_locator` provides helper classes
321321
and functions to place your (inset) axes at the anchored position of
322-
the parent axes, similarly to AnchoredArtis.
322+
the parent axes, similarly to AnchoredArtist.
323323

324324
Using :func:`mpl_toolkits.axes_grid.inset_locator.inset_axes`, you
325325
can have inset axes whose size is either fixed, or a fixed proportion
@@ -359,7 +359,7 @@ represented by the inset axes.
359359
RGB Axes
360360
~~~~~~~~
361361

362-
RGBAxes is a helper clase to conveniently show RGB composite
362+
RGBAxes is a helper class to conveniently show RGB composite
363363
images. Like ImageGrid, the location of axes are adjusted so that the
364364
area occupied by them fits in a given rectangle. Also, the xaxis and
365365
yaxis of each axes are shared. ::
@@ -386,7 +386,7 @@ AxisArtist
386386

387387
AxisArtist module provides a custom (and very experimental) Axes
388388
class, where each axis (left, right, top and bottom) have a separate
389-
artist associated which is resposible to draw axis-line, ticks,
389+
artist associated which is responsible to draw axis-line, ticks,
390390
ticklabels, label. Also, you can create your own axis, which can pass
391391
through a fixed position in the axes coordinate, or a fixed position
392392
in the data coordinate (i.e., the axis floats around when viewlimit
@@ -407,7 +407,7 @@ To create an axes, ::
407407
ax = AA.Axes(fig, [0.1, 0.1, 0.8, 0.8])
408408
fig.add_axes(ax)
409409

410-
or to creat a subplot ::
410+
or to create a subplot ::
411411

412412
ax = AA.Subplot(fig, 111)
413413
fig.add_subplot(ax)
@@ -441,7 +441,7 @@ Or a fixed axis with some offset ::
441441
AxisArtist with ParasiteAxes
442442
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
443443

444-
Most commands in the axes_grid toolkit1 can take a axes_class keyword
444+
Most commands in the axes_grid1 toolkit can take a axes_class keyword
445445
argument, and the commands creates an axes of the given class. For example,
446446
to create a host subplot with axisartist.Axes, ::
447447

@@ -458,10 +458,10 @@ Here is an example that uses parasiteAxes.
458458

459459

460460

461-
Curvelinear Grid
461+
Curvilinear Grid
462462
----------------
463463

464-
The motivation behind the AxisArtist module is to support cuvelinear grid
464+
The motivation behind the AxisArtist module is to support curvilinear grid
465465
and ticks.
466466

467467
.. plot:: mpl_toolkits/axes_grid/examples/demo_floating_axis.py
@@ -472,7 +472,7 @@ See :ref:`axisartist-manual` for more details.
472472
Floating Axes
473473
-------------
474474

475-
This also suppport a Floating Axes whose outer axis are defined as
475+
This also support a Floating Axes whose outer axis are defined as
476476
floating axis.
477477

478478
.. plot:: mpl_toolkits/axes_grid/examples/demo_floating_axes.py

examples/axes_grid/demo_axes_divider.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def demo_locatable_axes_hard(fig1):
2727
# axes for image
2828
ax = LocatableAxes(fig1, divider.get_position())
2929

30-
# axes for coloarbar
30+
# axes for colorbar
3131
ax_cb = LocatableAxes(fig1, divider.get_position())
3232

3333
h = [Size.AxesX(ax), # main axes
@@ -117,7 +117,7 @@ def demo():
117117

118118

119119
## PLOT 4
120-
# two images side by sied with fixed padding.
120+
# two images side by side with fixed padding.
121121

122122
ax = fig1.add_subplot(2, 2, 4)
123123
demo_images_side_by_sied(ax)

0 commit comments

Comments
 (0)