Merge pull request #20795 from tacaswell/mnt_deprecate_unused_fixture

jklymak · web-flow · commit d958497b5538 · 2021-08-06T09:15:10.000-07:00
diff --git a/doc/api/next_api_changes/deprecations/20795-TAC.rst b/doc/api/next_api_changes/deprecations/20795-TAC.rst
@@ -0,0 +1,5 @@
+Remove unused pytest fixture
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The fixture ``matplotlib.testing.conftest.mpl_image_comparison_parameters``
+is not used internally by Matplotlib.  If you use this please copy it
+into your code base.
diff --git a/lib/matplotlib/testing/conftest.py b/lib/matplotlib/testing/conftest.py
@@ -89,6 +89,7 @@ def mpl_test_settings(request):
 
 
 @pytest.fixture
+@_api.deprecated("3.5", alternative="none")
 def mpl_image_comparison_parameters(request, extension):
     # This fixture is applied automatically by the image_comparison decorator.
     #
diff --git a/lib/matplotlib/tests/conftest.py b/lib/matplotlib/tests/conftest.py
@@ -1,4 +1,3 @@
 from matplotlib.testing.conftest import (mpl_test_settings,
-                                         mpl_image_comparison_parameters,
                                          pytest_configure, pytest_unconfigure,
                                          pd)
diff --git a/lib/mpl_toolkits/tests/conftest.py b/lib/mpl_toolkits/tests/conftest.py
@@ -1,3 +1,2 @@
 from matplotlib.testing.conftest import (mpl_test_settings,
-                                         mpl_image_comparison_parameters,
                                          pytest_configure, pytest_unconfigure)

Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,7 @@ def mpl_test_settings(request):`
`89`	`89`
`90`	`90`
`91`	`91`	`@pytest.fixture`
	`92`	`+@_api.deprecated("3.5", alternative="none")`
`92`	`93`	`def mpl_image_comparison_parameters(request, extension):`
`93`	`94`	`# This fixture is applied automatically by the image_comparison decorator.`
`94`	`95`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`from matplotlib.testing.conftest import (mpl_test_settings,`
`2`		`- mpl_image_comparison_parameters,`
`3`	`2`	`pytest_configure, pytest_unconfigure)`