FIX: review suggestions

jklymak · jklymak · commit 8be6678d155c · 2021-11-23T11:10:15.000+01:00
diff --git a/tutorials/intermediate/arranging_axes.py b/tutorials/intermediate/arranging_axes.py
@@ -66,6 +66,10 @@
 sometimes useful for interactive work or to place an Axes in a custom
 location:
 
+`~matplotlib.figure.Figure.add_axes`
+    Adds a single axes at a location specified by
+    ``[left, bottom, widtg, height]`` in fractions of figure width or height.
+
 `~matplotlib.pyplot.subplot` or `.Figure.add_subplot`
     Adds a single subplot on a figure, with 1-based indexing (inherited from
     Matlab).  Columns and rows can be spanned by specifying a range of grid
@@ -86,17 +90,16 @@
 # --------------
 #
 # We can create a basic 2-by-2 grid of Axes using
-# :func:`~matplotlib.pyplot.subplots`.  It returns a
-# :class:`~matplotlib.figure.Figure` instance and an array of
-# :class:`~matplotlib.axes.Axes` objects.  The Axes objects can
-# be used to access methods to place artists on the Axes; here we
-# use `~.Axes.annotate`, but other examples could be `~.Axes.plot`,
+# `~matplotlib.pyplot.subplots`.  It returns a `~matplotlib.figure.Figure`
+# instance and an array of `~matplotlib.axes.Axes` objects.  The Axes
+# objects can be used to access methods to place artists on the Axes; here
+# we use `~.Axes.annotate`, but other examples could be `~.Axes.plot`,
 # `~.Axes.pcolormesh`, etc.
 
 import matplotlib.pyplot as plt
 import numpy as np
 
-fig, axs = plt.subplots(ncols=2, nrows=2, figsize=(4.5, 3.5),
+fig, axs = plt.subplots(ncols=2, nrows=2, figsize=(5.5, 3.5),
                         constrained_layout=True)
 # add an artist, in this case a nice label in the middle...
 for row in range(2):
@@ -124,9 +127,9 @@ def annotate_axes(ax, text, fontsize=18):
 # representing a row, and each element in the list a key representing the
 # column.
 
-fig, axd = plt.subplot_mosaic([['upleft', 'upright'],
-                               ['loleft', 'loright']],
-                              figsize=(4.5, 3.5), constrained_layout=True)
+fig, axd = plt.subplot_mosaic([['upper left', 'upper right'],
+                               ['lower left', 'lower right']],
+                              figsize=(5.5, 3.5), constrained_layout=True)
 for k in axd.keys():
     annotate_axes(axd[k], f'axd["{k}"]', fontsize=14)
 fig.suptitle('plt.subplot_mosaic()')
@@ -140,9 +143,9 @@ def annotate_axes(ax, text, fontsize=18):
 # convenient is probably to use `~.pyplot.subplot_mosaic` by repeating one
 # of the keys:
 
-fig, axd = plt.subplot_mosaic([['upleft', 'right'],
-                               ['loleft', 'right']],
-                              figsize=(4.5, 3.5), constrained_layout=True)
+fig, axd = plt.subplot_mosaic([['upper left', 'right'],
+                               ['lower left', 'right']],
+                              figsize=(5.5, 3.5), constrained_layout=True)
 for k in axd.keys():
     annotate_axes(axd[k], f'axd["{k}"]', fontsize=14)
 fig.suptitle('plt.subplot_mosaic()')
@@ -157,14 +160,14 @@ def annotate_axes(ax, text, fontsize=18):
 # Both `~.pyplot.subplots` and `~.pyplot.subplot_mosaic` allow the rows
 # in the grid to be different heights, and the columns to be different
 # widths using the *gridspec_kw* keyword argument.
-# Spacing parameters accepted by :class:`~matplotlib.gridspec.GridSpec`
+# Spacing parameters accepted by `~matplotlib.gridspec.GridSpec`
 # can be passed to `~matplotlib.pyplot.subplots` and
 # `~matplotlib.pyplot.subplot_mosaic`:
 
 gs_kw = dict(width_ratios=[1.4, 1], height_ratios=[1, 2])
-fig, axd = plt.subplot_mosaic([['upleft', 'right'],
-                               ['loleft', 'right']],
-                              gridspec_kw=gs_kw, figsize=(4.5, 3.5),
+fig, axd = plt.subplot_mosaic([['upper left', 'right'],
+                               ['lower left', 'right']],
+                              gridspec_kw=gs_kw, figsize=(5.5, 3.5),
                               constrained_layout=True)
 for k in axd.keys():
     annotate_axes(axd[k], f'axd["{k}"]', fontsize=14)
@@ -175,7 +178,7 @@ def annotate_axes(ax, text, fontsize=18):
 # -------------------
 #
 # Sometimes it is helpful to have two or more grids of Axes that
-# may not need to be related to one another.  The most simple way to
+# may not need to be related to one another.  The most simple way toin
 # accomplish this is to use `.Figure.subfigures`.  Note that the alignement
 # of the subfigure layouts is independent with the Axes spines in each
 # subfigure having independent positions.  See below for a more verbose
@@ -201,8 +204,8 @@ def annotate_axes(ax, text, fontsize=18):
 
 inner = [['innerA'],
          ['innerB']]
-outer = [['upleft',  inner],
-          ['lowleft', 'lowright']]
+outer = [['upper left',  inner],
+          ['lower left', 'lower right']]
 
 fig, axd = plt.subplot_mosaic(outer, constrained_layout=True)
 for k in axd.keys():
@@ -227,16 +230,21 @@ def annotate_axes(ax, text, fontsize=18):
 # We can accopmplish a 2x2 grid in the same manner as
 # ``plt.subplots(2, 2)``:
 
-fig = plt.figure(figsize=(4.5, 3.5), constrained_layout=True)
+fig = plt.figure(figsize=(5.5, 3.5), constrained_layout=True)
 spec = fig.add_gridspec(ncols=2, nrows=2)
+
 ax0 = fig.add_subplot(spec[0, 0])
 annotate_axes(ax0, 'ax0')
+
 ax1 = fig.add_subplot(spec[0, 1])
 annotate_axes(ax1, 'ax1')
+
 ax2 = fig.add_subplot(spec[1, 0])
 annotate_axes(ax2, 'ax2')
+
 ax3 = fig.add_subplot(spec[1, 1])
 annotate_axes(ax3, 'ax3')
+
 fig.suptitle('Manually added subplots using add_gridspec')
 
 ##############################################################################
@@ -248,14 +256,18 @@ def annotate_axes(ax, text, fontsize=18):
 # and the new Axes will span the slice.  This would be the same
 # as ``fig, axd = plt.subplot_mosaic([['ax0', 'ax0'], ['ax1', 'ax2']], ...)``:
 
-fig = plt.figure(figsize=(4.5, 3.5), constrained_layout=True)
+fig = plt.figure(figsize=(5.5, 3.5), constrained_layout=True)
 spec = fig.add_gridspec(2, 2)
+
 ax0 = fig.add_subplot(spec[0, :])
 annotate_axes(ax0, 'ax0')
+
 ax10 = fig.add_subplot(spec[1, 0])
 annotate_axes(ax10, 'ax10')
+
 ax11 = fig.add_subplot(spec[1, 1])
 annotate_axes(ax11, 'ax11')
+
 fig.suptitle('Manually added subplots, spanning a column')
 
 ###############################################################################
@@ -288,7 +300,7 @@ def annotate_axes(ax, text, fontsize=18):
 # -------------------------------
 #
 # You can create nested layout similar to `~.Figure.subfigures` using
-# `~.gridspec.SubplotSpec.subgridspec`.  Here the Axes spines _are_
+# `~.gridspec.SubplotSpec.subgridspec`.  Here the Axes spines *are*
 # aligned.
 #
 # Note this is also available from the more verbose
@@ -316,7 +328,7 @@ def annotate_axes(ax, text, fontsize=18):
 
 ###############################################################################
 # Here's a more sophisticated example of nested *GridSpec*: We create an outer
-# 4x4 grid with each cell containing and inner 3x3 grid of Axes. We outline
+# 4x4 grid with each cell containing an inner 3x3 grid of Axes. We outline
 # the outer 4x4 grid by hiding appropriate spines in each of the inner 3x3
 # grids.
 
@@ -352,7 +364,7 @@ def squiggle_xy(a, b, c, d, i=np.arange(0.0, 2*np.pi, 0.05)):
 # ============
 #
 #  - More details about :doc:`subplot mosaic </tutorials/provisional/mosaic>`.
-#  - more details about
+#  - More details about
 #    :doc:`constrained layout
 #    </tutorials/intermediate/constrainedlayout_guide>`, used to align
 #    spacing in most of these examples.
