Deprecate Bbox.anchored() with no container.

anntzer · anntzer · commit 9792aabf88f7 · 2023-01-09T22:52:49.000+01:00
This previously returned a copy of the bbox itself, and was completely
unused; let's deprecate this for clarity ("anchoring a bbox to itself"
doesn't make much sense anyways).
diff --git a/doc/api/next_api_changes/deprecations/24913-AL.rst b/doc/api/next_api_changes/deprecations/24913-AL.rst
@@ -0,0 +1,3 @@
+``bbox.anchored()`` with no explicit container
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Not passing a *container* argument to `.BboxBase.anchored` is now deprecated.
diff --git a/lib/matplotlib/transforms.py b/lib/matplotlib/transforms.py
@@ -501,21 +501,21 @@ def anchored(self, c, container=None):
             bottom, 1 is right or top), 'C' (center), or a cardinal direction
             ('SW', southwest, is bottom left, etc.).
         container : `Bbox`, optional
-            The box within which the `Bbox` is positioned; it defaults
-            to the initial `Bbox`.
+            The box within which the `Bbox` is positioned.
 
         See Also
         --------
         .Axes.set_anchor
         """
         if container is None:
+            _api.warn_deprecated(
+                "3.8", message="Calling anchored() with no container bbox "
+                "returns a frozen copy of the original bbox and is deprecated "
+                "since %(since)s.")
             container = self
         l, b, w, h = container.bounds
-        if isinstance(c, str):
-            cx, cy = self.coefs[c]
-        else:
-            cx, cy = c
         L, B, W, H = self.bounds
+        cx, cy = self.coefs[c] if isinstance(c, str) else c
         return Bbox(self._points +
                     [(l + cx * (w - W)) - L,
                      (b + cy * (h - H)) - B])

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``bbox.anchored()`` with no explicit container
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	+Not passing a container argument to `.BboxBase.anchored` is now deprecated.