Make AxesStack private

timhoffm · timhoffm · commit c8e610ee8a55 · 2019-05-19T21:20:57.000+02:00
diff --git a/doc/api/next_api_changes/2019-05-20-TH.rst b/doc/api/next_api_changes/2019-05-20-TH.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+``matplotlib.figure.AxesStack`` is considered private API and will be removed
+from the public API in future versions.
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -51,16 +51,16 @@ def _stale_figure_callback(self, val):
         self.figure.stale = val
 
 
-class AxesStack(cbook.Stack):
+class _AxesStack(cbook.Stack):
     """
     Specialization of the `.Stack` to handle all tracking of
     `~matplotlib.axes.Axes` in a `.Figure`.
     This stack stores ``key, (ind, axes)`` pairs, where:
 
-        * **key** should be a hash of the args and kwargs
-          used in generating the Axes.
-        * **ind** is a serial number for tracking the order
-          in which axes were added.
+    * **key** should be a hash of the args and kwargs
+      used in generating the Axes.
+    * **ind** is a serial number for tracking the order
+      in which axes were added.
 
     The AxesStack is a callable, where ``ax_stack()`` returns
     the current axes. Alternatively the :meth:`current_key_axes` will
@@ -161,6 +161,11 @@ def __contains__(self, a):
         return a in self.as_list()
 
 
+@cbook.deprecated("3.2")
+class AxesStack(_AxesStack):
+    pass
+
+
 class SubplotParams(object):
     """
     A class to hold the parameters for a subplot.
@@ -378,7 +383,7 @@ def __init__(self,
 
         self.set_tight_layout(tight_layout)
 
-        self._axstack = AxesStack()  # track all figure axes and current axes
+        self._axstack = _AxesStack()  # track all figure axes and current axes
         self.clf()
         self._cachedRenderer = None
 
