Merge pull request #9132 from afvincent/doc_axes_collision_deprecation

anntzer · web-flow · commit 19a9d4efc411 · 2017-08-31T01:31:08.000-07:00
DOC: document axes-collision deprecation
diff --git a/doc/api/api_changes/2017-30-08_AFV_deprecation_of_axes_collision.rst b/doc/api/api_changes/2017-30-08_AFV_deprecation_of_axes_collision.rst
@@ -0,0 +1,16 @@
+Deprecation of axes collision
+-----------------------------
+
+Adding an axes instance to a figure by using the same arguments as for
+a previous axes instance currently reuses the earlier instance.  This
+behavior has been deprecated in Matplotlib 2.1. In a future version, a
+*new* instance will always be created and returned.  Meanwhile, in such
+a situation, a deprecation warning is raised by
+:class:`~matplotlib.figure.AxesStack`.
+
+This warning can be suppressed, and the future behavior ensured, by passing
+a *unique* label to each axes instance.  See the docstring of
+:meth:`~matplotlib.figure.Figure.add_axes` for more information.
+
+Additional details on the rationale behind this deprecation can be found
+in :issue:`7377` and :issue:`9024`.
