Merge pull request #24806 from ksunden/begin_typing_arg

timhoffm · web-flow · commit 1d13d2d3c25f · 2022-12-22T08:51:10.000+01:00
Deprecate 'x' argument for widgets.TextBox.begin_typing
diff --git a/doc/api/next_api_changes/deprecations/24806-KS.rst b/doc/api/next_api_changes/deprecations/24806-KS.rst
@@ -0,0 +1,4 @@
+Deprecate unused parameter *x* to ``TextBox.begin_typing``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This parameter was unused in the method, but was a required argument.
diff --git a/lib/matplotlib/tests/test_widgets.py b/lib/matplotlib/tests/test_widgets.py
@@ -984,7 +984,7 @@ def test_TextBox(ax, toolbar):
     assert tool.text == 'x**2'
     assert text_change_event.call_count == 1
 
-    tool.begin_typing(tool.text)
+    tool.begin_typing()
     tool.stop_typing()
 
     assert submit_event.call_count == 2
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1338,7 +1338,8 @@ def set_val(self, val):
             self._observers.process('change', self.text)
             self._observers.process('submit', self.text)
 
-    def begin_typing(self, x):
+    @_api.delete_parameter("3.7", "x")
+    def begin_typing(self, x=None):
         self.capturekeystrokes = True
         # Disable keypress shortcuts, which may otherwise cause the figure to
         # be saved, closed, etc., until the user stops typing.  The way to
@@ -1385,7 +1386,7 @@ def _click(self, event):
         if event.canvas.mouse_grabber != self.ax:
             event.canvas.grab_mouse(self.ax)
         if not self.capturekeystrokes:
-            self.begin_typing(event.x)
+            self.begin_typing()
         self.cursor_index = self.text_disp._char_index_at(event.x)
         self._rendercursor()
 
