Deprecate inset_locator.InsetPosition.

anntzer · anntzer · commit 2f0724e1271e · 2023-07-12T09:51:47.000+02:00
There's Axes.inset_axes which is an exact replacement without the need of actually understanding what an axes locator is, and which is also more general as one can also set a custom transform on inset_axes instead of being limited to the transAxes of a given parent axes. Also the method had never been used in the library or examples, and a test was only ever added in 6dd30a2 (2022).
diff --git a/doc/api/next_api_changes/deprecations/26295-AL.rst b/doc/api/next_api_changes/deprecations/26295-AL.rst
@@ -0,0 +1,3 @@
+``inset_location.InsetPosition`` is deprecated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Use `~.Axes.inset_axes` instead.
diff --git a/lib/mpl_toolkits/axes_grid1/inset_locator.py b/lib/mpl_toolkits/axes_grid1/inset_locator.py
@@ -13,6 +13,7 @@
 from .parasite_axes import HostAxes
 
 
+@_api.deprecated("3.8", alternative="Axes.inset_axes")
 class InsetPosition:
     @_docstring.dedent_interpd
     def __init__(self, parent, lbwh):
