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 1a243a2

Browse filesBrowse files
committed
Slightly reword intros of mpl_toolkits API docs.
1 parent 36c6632 commit 1a243a2
Copy full SHA for 1a243a2

File tree

Expand file treeCollapse file tree

3 files changed

+25
-33
lines changed
Filter options
Expand file treeCollapse file tree

3 files changed

+25
-33
lines changed

‎doc/api/toolkits/axes_grid.rst

Copy file name to clipboard
+11-15Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,22 @@
11
.. _axes_grid-api-index:
22

3-
Matplotlib axes_grid Toolkit
4-
============================
3+
``mpl_toolkits.axes_grid``
4+
==========================
55

66
.. currentmodule:: mpl_toolkits
77

8-
98
.. note::
10-
AxesGrid toolkit has been a part of matplotlib since v
11-
0.99. Originally, the toolkit had a single namespace of
12-
*axes_grid*. In more recent version, the toolkit
13-
has divided into two separate namespace (*axes_grid1* and *axisartist*).
14-
While *axes_grid* namespace is maintained for the backward compatibility,
15-
use of *axes_grid1* and *axisartist* is recommended.
16-
For the documentation on ``axes_grid``,
17-
see the `previous version of the docs
18-
<https://matplotlib.org/2.0.1/mpl_toolkits/axes_grid/index.html#toolkit-axesgrid-index>`_.
9+
AxesGrid has been a part of matplotlib since v 0.99. Originally, the toolkit
10+
used the *axes_grid* namespace. In more recent versions, the toolkit
11+
has been split into *axes_grid1* and *axisartist*. While *axes_grid*
12+
is maintained for the backward compatibility, use of *axes_grid1* and
13+
*axisartist* is recommended. For the documentation on ``axes_grid``, see
14+
the `previous version of the docs`__.
15+
16+
.. __: https://matplotlib.org/2.0.1/mpl_toolkits/axes_grid/index.html
1917

2018
.. toctree::
2119
:maxdepth: 1
22-
20+
2321
axes_grid1
2422
axisartist
25-
26-

‎doc/api/toolkits/axes_grid1.rst

Copy file name to clipboardExpand all lines: doc/api/toolkits/axes_grid1.rst
+6-9Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
.. module:: mpl_toolkits.axes_grid1
22

3-
Matplotlib axes_grid1 Toolkit
4-
=============================
3+
``mpl_toolkits.axes_grid1``
4+
===========================
55

6-
The matplotlib :mod:`mpl_toolkits.axes_grid1` toolkit is a collection of
7-
helper classes to ease displaying multiple images in matplotlib. While the
8-
aspect parameter in matplotlib adjust the position of the single axes,
9-
axes_grid1 toolkit provides a framework to adjust the position of
10-
multiple axes according to their aspects.
6+
:mod:`mpl_toolkits.axes_grid1` provides a framework of helper classes to adjust
7+
the positioning of multiple fixed-aspect Axes (e.g., displaying images). It
8+
can be contrasted with the ``aspect`` property of Matplotlib Axes, which
9+
adjusts the position of a single Axes.
1110

1211
See :ref:`axes_grid1_users-guide-index` for a guide on the usage of axes_grid1.
1312

@@ -32,5 +31,3 @@ See :ref:`axes_grid1_users-guide-index` for a guide on the usage of axes_grid1.
3231
axes_grid1.inset_locator
3332
axes_grid1.mpl_axes
3433
axes_grid1.parasite_axes
35-
36-

‎doc/api/toolkits/axisartist.rst

Copy file name to clipboardExpand all lines: doc/api/toolkits/axisartist.rst
+8-9Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
.. module:: mpl_toolkits.axisartist
22

3-
Matplotlib axisartist Toolkit
4-
=============================
3+
``mpl_toolkits.axisartist``
4+
===========================
55

6-
The *axisartist* namespace includes a derived Axes implementation (
7-
:class:`mpl_toolkits.axisartist.Axes`). The
8-
biggest difference is that the artists that are responsible for drawing
9-
axis lines, ticks, ticklabels, and axis labels are separated out from the
10-
mpl's Axis class. This change was strongly motivated to support curvilinear grid.
6+
The *axisartist* namespace provides a derived Axes implementation
7+
(:class:`mpl_toolkits.axisartist.Axes`), designed to support curvilinear
8+
grids. The biggest difference is that the artists that are responsible for
9+
drawing axis lines, ticks, ticklabels, and axis labels are separated out from
10+
Matplotlib's Axis class.
1111

12-
You can find a tutorial describing usage of axisartist at the
12+
You can find a tutorial describing usage of axisartist at the
1313
:ref:`axisartist_users-guide-index` user guide.
1414

1515
.. figure:: ../../gallery/axisartist/images/sphx_glr_demo_curvelinear_grid_001.png
@@ -37,4 +37,3 @@ You can find a tutorial describing usage of axisartist at the
3737
axisartist.grid_finder
3838
axisartist.grid_helper_curvelinear
3939
axisartist.parasite_axes
40-

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.