Merge pull request #16746 from anntzer/cbwad

timhoffm · web-flow · commit e283ff6cf1b0 · 2020-03-14T21:35:15.000+01:00
Reword colorbar-with-axes-divider example.
diff --git a/examples/axes_grid1/demo_colorbar_with_axes_divider.py b/examples/axes_grid1/demo_colorbar_with_axes_divider.py
@@ -1,14 +1,13 @@
 """
-===============================
-Demo Colorbar with Axes Divider
-===============================
+============================
+Colorbar with `.AxesDivider`
+============================
 
-The make_axes_locatable function (part of the axes_divider module) takes an
-existing axes, creates a divider for it and returns an instance of the
-AxesLocator class. The append_axes method of this AxesLocator can then be used
-to create a new axes on a given side ("top", "right", "bottom", or "left") of
-the original axes. This example uses Axes Divider to add colorbars next to
-axes.
+The `.axes_divider.make_axes_locatable` function takes an existing axes, adds
+it to a new `.AxesDivider` and returns the `.AxesDivider`.  The `.append_axes`
+method of the `.AxesDivider` can then be used to create a new axes on a given
+side ("top", "right", "bottom", or "left") of the original axes. This example
+uses `.append_axes` to add colorbars next to axes.
 """
 
 import matplotlib.pyplot as plt
@@ -19,17 +18,17 @@
 
 im1 = ax1.imshow([[1, 2], [3, 4]])
 ax1_divider = make_axes_locatable(ax1)
-# add an axes to the right of the main axes.
+# Add an axes to the right of the main axes.
 cax1 = ax1_divider.append_axes("right", size="7%", pad="2%")
 cb1 = fig.colorbar(im1, cax=cax1)
 
 im2 = ax2.imshow([[1, 2], [3, 4]])
 ax2_divider = make_axes_locatable(ax2)
-# add an axes above the main axes.
+# Add an axes above the main axes.
 cax2 = ax2_divider.append_axes("top", size="7%", pad="2%")
 cb2 = fig.colorbar(im2, cax=cax2, orientation="horizontal")
-# change tick position to top. Tick position defaults to bottom and overlaps
-# the image.
+# Change tick position to top (with the default tick position "bottom", ticks
+# overlap the image).
 cax2.xaxis.set_ticks_position("top")
 
 plt.show()
