Deprecate unused "frac" key in annotate() arrowprops.

anntzer · anntzer · commit f1eacc3cdb22 · 2023-06-06T00:07:07.000+02:00
This key has been unused for ~8y (197fc9f).
diff --git a/doc/api/next_api_changes/deprecations/26780-AL.rst b/doc/api/next_api_changes/deprecations/26780-AL.rst
@@ -0,0 +1,3 @@
+Support for passing the "frac" key in ``annotate(..., arrowprops={"frac": ...})``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... has been removed.  This key has had no effect since Matplotlib 1.5.
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1838,9 +1838,12 @@ def transform(renderer) -> Transform
                 self._arrow_relpos = arrowprops.pop("relpos", (0.5, 0.5))
             else:
                 # modified YAArrow API to be used with FancyArrowPatch
-                for key in [
-                        'width', 'headwidth', 'headlength', 'shrink', 'frac']:
+                for key in ['width', 'headwidth', 'headlength', 'shrink']:
                     arrowprops.pop(key, None)
+                if 'frac' in arrowprops:
+                    _api.warn_deprecated(
+                        "3.8", message="Support for passing the (unused) 'frac' key "
+                        "has been removed %(since)s and will be removed %(removal)s.")
             self.arrow_patch = FancyArrowPatch((0, 0), (1, 1), **arrowprops)
         else:
             self.arrow_patch = None
@@ -1933,10 +1936,6 @@ def update_positions(self, renderer):
             shrink = arrowprops.get('shrink', 0.0)
             width = arrowprops.get('width', 4)
             headwidth = arrowprops.get('headwidth', 12)
-            if 'frac' in arrowprops:
-                _api.warn_external(
-                    "'frac' option in 'arrowprops' is no longer supported;"
-                    " use 'headlength' to set the head length in points.")
             headlength = arrowprops.get('headlength', 12)
 
             # NB: ms is in pts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Support for passing the "frac" key in ``annotate(..., arrowprops={"frac": ...})``
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+... has been removed. This key has had no effect since Matplotlib 1.5.`