Skip to content

DOC: document axes-collision deprecation #9132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anntzer merged 1 commit into from
Aug 31, 2017
Merged

DOC: document axes-collision deprecation #9132

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/api/api_changes/2017-30-08_AFV_deprecation_of_axes_collision.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.