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.

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
merged 1 commit into from
Aug 31, 2017

Conversation

afvincent
Copy link
Contributor

Trying to address #9041 by adding an entry in api_changes about the deprecation of axes collisions. The text is shamelessly inspired from the deprecation warning message.

Tagging it release-critical as #9041 is.

@afvincent afvincent added the Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions. label Aug 31, 2017
@afvincent afvincent added this to the 2.1 (next point release) milestone Aug 31, 2017
@afvincent afvincent requested review from tacaswell and anntzer August 31, 2017 02:50
Deprecation of axes collision
-----------------------------

The following is related to the PR #9037 (and incidentally to #9034 too).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you tag these as


:issue:`XXXX`

so they link right?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also move them to the bottom of the message. The relevant issues are actually #7377 (where most of the rationale is discussed) and #9024; #9034 and #9037 are just technicalities.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rephrased the mention to use the issue # suggestd by @anntzer and moved it at the end of the entry. Plus now using the :issue: tag.

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
(likely 2.3), a *new* instance will always be created and returned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I always prefer not indicating the version where removal actually occurs, or is planned to occur: there will be a new note in the changelog when removal actually occurs anyways, and we may as well keep more flexibility this way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was the reason for using "likely" before "2.3" 😈... Well, I simply removed the mention of the version.

@afvincent afvincent force-pushed the doc_axes_collision_deprecation branch from 3ba3ff8 to ad0ef8b Compare August 31, 2017 05:29
@afvincent
Copy link
Contributor Author

@anntzer and @tacaswell, your comments (should) have been fixed in the squashed and rebased version.

@anntzer anntzer merged commit 19a9d4e into matplotlib:master Aug 31, 2017
@anntzer
Copy link
Contributor

anntzer commented Aug 31, 2017

thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants