Merge pull request #12721 from timhoffm/get-scale-docs-internal

anntzer · web-flow · commit 6dfbfd8abe70 · 2018-11-03T11:11:19.000+01:00
Make get_scale_docs() internal
diff --git a/doc/api/next_api_changes/2018-11-02-TH-deprecations.rst b/doc/api/next_api_changes/2018-11-02-TH-deprecations.rst
@@ -0,0 +1,6 @@
+Deprecations
+````````````
+
+The function ``matplotlib.scale.get_scale_docs()`` and its alias
+``matplotlib.pyplot.get_scale_docs()`` are considered internal and will be
+removed from the public API in a future version.
diff --git a/lib/matplotlib/scale.py b/lib/matplotlib/scale.py
@@ -579,7 +579,17 @@ def register_scale(scale_class):
     _scale_mapping[scale_class.name] = scale_class
 
 
+@cbook.deprecated(
+    '3.1', message='get_scale_docs() is considered private API since '
+                   '3.1 and will be removed from the public API in 3.3.')
 def get_scale_docs():
+    """
+    Helper function for generating docstrings related to scales.
+    """
+    return _get_scale_docs()
+
+
+def _get_scale_docs():
     """
     Helper function for generating docstrings related to scales.
     """
@@ -598,5 +608,5 @@ def get_scale_docs():
 
 docstring.interpd.update(
     scale=' | '.join([repr(x) for x in get_scale_names()]),
-    scale_docs=get_scale_docs().rstrip(),
+    scale_docs=_get_scale_docs().rstrip(),
     )
