@@ -974,28 +974,22 @@ def gca(**kwargs):
974
974
975
975
def subplot (* args , ** kwargs ):
976
976
"""
977
- Return a subplot axes positioned by the given grid definition .
977
+ Return a subplot axes at the given grid position .
978
978
979
- Typical call signature::
979
+ Call signature::
980
980
981
- subplot(nrows, ncols, plot_number )
981
+ subplot(nrows, ncols, index, **kwargs )
982
982
983
- Where *nrows* and *ncols* are used to notionally split the figure
984
- into ``nrows * ncols`` sub-axes, and *plot_number* is used to identify
985
- the particular subplot that this function is to create within the notional
986
- grid. *plot_number* starts at 1, increments across rows first and has a
987
- maximum of ``nrows * ncols``.
983
+ In the current figure, create and return an `~.Axes`, at position *index*
984
+ of a (virtual) grid of *nrows* by *ncols* axes. Indexes go from 1 to
985
+ ``nrows * ncols``, incrementing in row-major order.
988
986
989
- In the case when *nrows*, *ncols* and *plot_number* are all less than 10,
990
- a convenience exists, such that the a 3 digit number can be given instead,
991
- where the hundreds represent *nrows*, the tens represent *ncols* and the
992
- units represent *plot_number*. For instance::
987
+ If *nrows*, *ncols* and *index* are all less than 10, they can also be
988
+ given as a single, concatenated, three-digit number.
993
989
994
- subplot(211)
995
-
996
- produces a subaxes in a figure which represents the top plot (i.e. the
997
- first) in a 2 row by 1 column notional grid (no grid actually exists,
998
- but conceptually this is how the returned subplot has been positioned).
990
+ For example, ``subplot(2, 3, 3)`` and ``subplot(233)`` both create an
991
+ `~.Axes` at the top right corner of the current figure, occupying half of
992
+ the figure height and a third of the figure width.
999
993
1000
994
.. note::
1001
995
0 commit comments