8000 throw deprecation warning on empty call to fig.add_axes() by KSafran · Pull Request #15286 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

throw deprecation warning on empty call to fig.add_axes() #15286

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

Jump to bottom
Merged
merged 1 commit into from
Sep 18, 2019
Merged

throw deprecation warning on empty call to fig.add_axes() #15286

merged 1 commit into from
Sep 18, 2019

Conversation

KSafran
Copy link
Contributor
@KSafran KSafran commented Sep 18, 2019

PR Summary

Deprecate call to fig.add_axes() with no arguments as discussed in #15059

My first contribution, feedback is welcome. Unsure about adding API change to doc/api/next_api_changes.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

timhoffm
timhoffm approved these changes Sep 18, 2019
View reviewed changes
Copy link
Member
@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

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

Please add an API change note. By "unsure" do you mean unsure whether or how to add that note?

@timhoffm
Copy link
Member

@ core devs: Do we still want to bring this into 3.2?

@KSafran
Copy link
Contributor Author
KSafran commented Sep 18, 2019

Not sure how, looks like my .rst is breaking the documentation build.

@jklymak
Copy link
Member
jklymak commented Sep 18, 2019

@timhoffm I don't know where 3.2 is at, but this is a long-standing situation so I doubt its urgent

jklymak
jklymak reviewed Sep 18, 2019
View reviewed changes
doc/api/next_api_changes/deprecated_empty_add_axes.rst Outdated
Deprecations
````````````

Calling `fig.add_axes()` with no arguments currently return None,
Copy link
Member

Choose a reason for hiding this comment

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

This will try and link to a method in the library. You need to enclose in double backticks to make a literal.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks Jody

@KSafran KSafran force-pushed the deprecate-empty-add_axes branch from f32a4da to 31e7ceb Compare September 18, 2019 15:25
@jklymak
Copy link
Member
jklymak commented Sep 18, 2019

OK, I would merge this, but I';m not quite clear on the state of 3.2 and the deprecation API note. Ping @dstansby @ivanov

@dstansby
Copy link
Member

From a practical view, I think 3.2 should be regarded as feature/API change frozen now it's been branched, otherwise it's going to be a pain sorting out new API/what's new notes.

@jklymak jklymak added this to the v3.3.0 milestone Sep 18, 2019
@jklymak
Copy link
Member
jklymak commented Sep 18, 2019

OK, I had missed the fact/importance that 3.2 is branched. I would argue against worrying about backporting this.

@jklymak jklymak merged commit 48aab50 into matplotlib:master Sep 18, 2019
@timhoffm
Copy link
Member

@KSafran Thanks and congratulations to your first contribution to Matplotlib! Maybe see you back some time.

@timhoffm timhoffm mentioned this pull request Sep 18, 2019
Closed
@KSafran KSafran deleted the deprecate-empty-add_axes branch September 18, 2019 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
64B2
Reviewers

@jklymak jklymak jklymak approved these changes

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
API: argument checking API: changes API: consistency
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
4 participants
@KSafran @timhoffm @jklymak @dstansby
0