From 1a243a2397ffa862a0df2621bd031d0ca6e6f6bb Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Fri, 21 May 2021 14:14:24 +0200 Subject: [PATCH] Slightly reword intros of mpl_toolkits API docs. --- doc/api/toolkits/axes_grid.rst | 26 +++++++++++--------------- doc/api/toolkits/axes_grid1.rst | 15 ++++++--------- doc/api/toolkits/axisartist.rst | 17 ++++++++--------- 3 files changed, 25 insertions(+), 33 deletions(-) diff --git a/doc/api/toolkits/axes_grid.rst b/doc/api/toolkits/axes_grid.rst index 991b0ff6813a..c991ee61ed3c 100644 --- a/doc/api/toolkits/axes_grid.rst +++ b/doc/api/toolkits/axes_grid.rst @@ -1,26 +1,22 @@ .. _axes_grid-api-index: -Matplotlib axes_grid Toolkit -============================ +``mpl_toolkits.axes_grid`` +========================== .. currentmodule:: mpl_toolkits - .. note:: - AxesGrid toolkit has been a part of matplotlib since v - 0.99. Originally, the toolkit had a single namespace of - *axes_grid*. In more recent version, the toolkit - has divided into two separate namespace (*axes_grid1* and *axisartist*). - While *axes_grid* namespace is maintained for the backward compatibility, - use of *axes_grid1* and *axisartist* is recommended. - For the documentation on ``axes_grid``, - see the `previous version of the docs - `_. + AxesGrid has been a part of matplotlib since v 0.99. Originally, the toolkit + used the *axes_grid* namespace. In more recent versions, the toolkit + has been split into *axes_grid1* and *axisartist*. While *axes_grid* + is maintained for the backward compatibility, use of *axes_grid1* and + *axisartist* is recommended. For the documentation on ``axes_grid``, see + the `previous version of the docs`__. + + .. __: https://matplotlib.org/2.0.1/mpl_toolkits/axes_grid/index.html .. toctree:: :maxdepth: 1 - + axes_grid1 axisartist - - diff --git a/doc/api/toolkits/axes_grid1.rst b/doc/api/toolkits/axes_grid1.rst index 3abbaf8f22c0..7dc95026a14d 100644 --- a/doc/api/toolkits/axes_grid1.rst +++ b/doc/api/toolkits/axes_grid1.rst @@ -1,13 +1,12 @@ .. module:: mpl_toolkits.axes_grid1 -Matplotlib axes_grid1 Toolkit -============================= +``mpl_toolkits.axes_grid1`` +=========================== -The matplotlib :mod:`mpl_toolkits.axes_grid1` toolkit is a collection of -helper classes to ease displaying multiple images in matplotlib. While the -aspect parameter in matplotlib adjust the position of the single axes, -axes_grid1 toolkit provides a framework to adjust the position of -multiple axes according to their aspects. +:mod:`mpl_toolkits.axes_grid1` provides a framework of helper classes to adjust +the positioning of multiple fixed-aspect Axes (e.g., displaying images). It +can be contrasted with the ``aspect`` property of Matplotlib Axes, which +adjusts the position of a single Axes. See :ref:`axes_grid1_users-guide-index` for a guide on the usage of axes_grid1. @@ -32,5 +31,3 @@ See :ref:`axes_grid1_users-guide-index` for a guide on the usage of axes_grid1. axes_grid1.inset_locator axes_grid1.mpl_axes axes_grid1.parasite_axes - - diff --git a/doc/api/toolkits/axisartist.rst b/doc/api/toolkits/axisartist.rst index f18246fef128..e045e68e54d2 100644 --- a/doc/api/toolkits/axisartist.rst +++ b/doc/api/toolkits/axisartist.rst @@ -1,15 +1,15 @@ .. module:: mpl_toolkits.axisartist -Matplotlib axisartist Toolkit -============================= +``mpl_toolkits.axisartist`` +=========================== -The *axisartist* namespace includes a derived Axes implementation ( -:class:`mpl_toolkits.axisartist.Axes`). The -biggest difference is that the artists that are responsible for drawing -axis lines, ticks, ticklabels, and axis labels are separated out from the -mpl's Axis class. This change was strongly motivated to support curvilinear grid. +The *axisartist* namespace provides a derived Axes implementation +(:class:`mpl_toolkits.axisartist.Axes`), designed to support curvilinear +grids. The biggest difference is that the artists that are responsible for +drawing axis lines, ticks, ticklabels, and axis labels are separated out from +Matplotlib's Axis class. -You can find a tutorial describing usage of axisartist at the +You can find a tutorial describing usage of axisartist at the :ref:`axisartist_users-guide-index` user guide. .. 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 axisartist.grid_finder axisartist.grid_helper_curvelinear axisartist.parasite_axes -