Merge pull request #23902 from oscargus/mpltoolkitsfixes

story645 · web-flow · commit 6586784d9c8c · 2022-09-20T00:11:04.000-04:00
Add test and improve examples for mpl_toolkits
diff --git a/examples/axes_grid1/inset_locator_demo2.py b/examples/axes_grid1/inset_locator_demo2.py
@@ -1,12 +1,15 @@
 """
-===================
-Inset Locator Demo2
-===================
+====================
+Inset Locator Demo 2
+====================
 
 This Demo shows how to create a zoomed inset via `.zoomed_inset_axes`.
 In the first subplot an `.AnchoredSizeBar` shows the zoom effect.
 In the second subplot a connection to the region of interest is
 created via `.mark_inset`.
+
+A version of the second subplot, not using the toolkit, is available in
+:doc:`/gallery/subplots_axes_and_figures/zoom_inset_axes`.
 """
 
 from matplotlib import cbook
diff --git a/examples/axisartist/demo_floating_axes.py b/examples/axisartist/demo_floating_axes.py
@@ -9,8 +9,8 @@
   the plot.
 * Using `~.floating_axes.GridHelperCurveLinear` to rotate the plot and set the
   plot boundary.
-* Using `~.floating_axes.FloatingSubplot` to create a subplot using the return
-  value from `~.floating_axes.GridHelperCurveLinear`.
+* Using `~.Figure.add_subplot` to create a subplot using the return value from
+  `~.floating_axes.GridHelperCurveLinear`.
 * Making a sector plot by adding more features to
   `~.floating_axes.GridHelperCurveLinear`.
 """
diff --git a/lib/mpl_toolkits/axes_grid1/inset_locator.py b/lib/mpl_toolkits/axes_grid1/inset_locator.py
@@ -43,7 +43,7 @@ def __init__(self, parent, lbwh):
 
         >>> parent_axes = plt.gca()
         >>> ax_ins = plt.axes([0, 0, 1, 1])
-        >>> ip = InsetPosition(ax, [0.5, 0.1, 0.4, 0.2])
+        >>> ip = InsetPosition(parent_axes, [0.5, 0.1, 0.4, 0.2])
         >>> ax_ins.set_axes_locator(ip)
         """
         self.parent = parent
diff --git a/lib/mpl_toolkits/tests/baseline_images/test_axes_grid1/insetposition.png b/lib/mpl_toolkits/tests/baseline_images/test_axes_grid1/insetposition.png
diff --git a/lib/mpl_toolkits/tests/test_axes_grid1.py b/lib/mpl_toolkits/tests/test_axes_grid1.py
@@ -21,7 +21,8 @@
     Divider, HBoxDivider, make_axes_area_auto_adjustable)
 from mpl_toolkits.axes_grid1.axes_rgb import RGBAxes
 from mpl_toolkits.axes_grid1.inset_locator import (
-    zoomed_inset_axes, mark_inset, inset_axes, BboxConnectorPatch)
+    zoomed_inset_axes, mark_inset, inset_axes, BboxConnectorPatch,
+    InsetPosition)
 import mpl_toolkits.axes_grid1.mpl_axes
 
 import pytest
@@ -571,6 +572,14 @@ def test_rgb_axes():
     ax.imshow_rgb(r, g, b, interpolation='none')
 
 
+@image_comparison(['insetposition.png'], remove_text=True)
+def test_insetposition():
+    fig, ax = plt.subplots(figsize=(2, 2))
+    ax_ins = plt.axes([0, 0, 1, 1])
+    ip = InsetPosition(ax, [0.2, 0.25, 0.5, 0.4])
+    ax_ins.set_axes_locator(ip)
+
+
 # The original version of this test relied on mpl_toolkits's slightly different
 # colorbar implementation; moving to matplotlib's own colorbar implementation
 # caused the small image comparison error.
