Skip to content
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

Deprecate nbagg.transparent rcParam. #10024

Merged
merged 1 commit into from
Dec 23, 2017

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Dec 16, 2017

See rationale in #8654, also discussion in #5419.

Unlike for #10023 I am not sure of the best way to handle the deprecation, as this is a change of defaults (from transparent to nontransparent), so the deprecation warning doesn't really help before the default is changed, but it's too late after...

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 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

@jklymak
Copy link
Member

jklymak commented Dec 18, 2017

If a user includes nbagg.transparent in an rcParam file can there just be a message that says it has been removed, and "please use figure.facecolor for the same functionality"? That would be less annoying than a deprecation message for something that is gone...

@anntzer
Copy link
Contributor Author

anntzer commented Dec 18, 2017

Sounds good, fixed.

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

This looks good to me. It works w/ jupyter, though I didn't have that rcparam set of course...

@dstansby dstansby added this to the v2.2 milestone Dec 23, 2017
@dstansby dstansby merged commit 8715f47 into matplotlib:master Dec 23, 2017
@anntzer anntzer deleted the nbagg-transparent branch December 23, 2017 19:00
efiring added a commit to efiring/matplotlib that referenced this pull request Jan 15, 2018
In matplotlib#10024, rcParams['nbagg.transparent'] was marked as deprecated
and ignored, but it was not removed from backend_nbagg.  As a
result, every plot made with backend_nbagg was raising a
warning.  This PR finishes matplotlib#10024 by removing the reference and
the line that depends on it.
@QuLogic QuLogic modified the milestones: needs sorting, v2.2.0 Feb 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants