Deprecate the tk_window_focus function.

anntzer · anntzer · commit 72d23843f78f · 2018-08-19T17:59:13.000+02:00
The tk backend has been reading directly from rcParams["tk.window_focus"] since 17e6145 (2005), and the function is unused since then.
diff --git a/doc/api/api_changes/2018-08-17-AL-deprecations.rst b/doc/api/api_changes/2018-08-17-AL-deprecations.rst
@@ -3,4 +3,5 @@ API deprecations
 
 The following API elements are deprecated:
 
+- ``tk_window_focus``,
 - ``mlab.demean``,
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -1379,6 +1379,7 @@ def is_interactive():
     return rcParams['interactive']
 
 
+@cbook.deprecated("3.1", alternative="rcParams['tk.window_focus']")
 def tk_window_focus():
     """Return true if focus maintenance under TkAgg on win32 is on.
      This currently works only for python.exe and IPython.exe.

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,5 @@ API deprecations`
`3`	`3`
`4`	`4`	`The following API elements are deprecated:`
`5`	`5`
	`6`	+- ``tk_window_focus``,
`6`	`7`	- ``mlab.demean``,