Merge pull request #25557 from anntzer/en

oscargus · web-flow · commit f3d907ca6492 · 2023-03-28T15:52:46.000+02:00
Rename parameter of Annotation.contains and Legend.contains.
diff --git a/doc/api/next_api_changes/deprecations/25557-AL.rst b/doc/api/next_api_changes/deprecations/25557-AL.rst
@@ -0,0 +1,3 @@
+The parameter of ``Annotation.contains`` and ``Legend.contains`` is renamed to *mouseevent*
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... consistently with `.Artist.contains`.
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -1173,8 +1173,9 @@ def _find_best_position(self, width, height, renderer, consider=None):
 
         return l, b
 
-    def contains(self, event):
-        return self.legendPatch.contains(event)
+    @_api.rename_parameter("3.8", "event", "mouseevent")
+    def contains(self, mouseevent):
+        return self.legendPatch.contains(mouseevent)
 
     def set_draggable(self, state, use_blit=False, update='loc'):
         """
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1848,12 +1848,13 @@ def transform(renderer) -> Transform
         # Must come last, as some kwargs may be propagated to arrow_patch.
         Text.__init__(self, x, y, text, **kwargs)
 
-    def contains(self, event):
-        if self._different_canvas(event):
+    @_api.rename_parameter("3.8", "event", "mouseevent")
+    def contains(self, mouseevent):
+        if self._different_canvas(mouseevent):
             return False, {}
-        contains, tinfo = Text.contains(self, event)
+        contains, tinfo = Text.contains(self, mouseevent)
         if self.arrow_patch is not None:
-            in_patch, _ = self.arrow_patch.contains(event)
+            in_patch, _ = self.arrow_patch.contains(mouseevent)
             contains = contains or in_patch
         return contains, tinfo
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+The parameter of ``Annotation.contains`` and ``Legend.contains`` is renamed to mouseevent
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	+... consistently with `.Artist.contains`.