8000 Deprecate cleared kwarg to get_renderer. by anntzer · Pull Request #22245 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Deprecate cleared kwarg to get_renderer. #22245

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
Jan 16, 2022
Merged

Deprecate cleared kwarg to get_renderer. #22245

merged 1 commit into from
Jan 16, 2022

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented Jan 16, 2022

This makes it easier for to mock the agg backend (e.g., in mplcairo).
Note that this is anyways only a shorthand for calling a method
(.clear()) on the renderer itself, so just issuing that call is just
as simple, more explicit, and can be done even when one just has access
to the renderer and not to the canvas (an admittedly rather hypothetical
case).

PR Summary

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

@anntzer anntzer added this to the v3.6.0 milestone Jan 16, 2022
dstansby
dstansby requested changes Jan 16, 2022
View reviewed changes
Copy link
Member
@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

The changelog filename needs updating. Otherwise looks 👍

@anntzer
Deprecate cleared kwarg to get_renderer.
548e08c 
This makes it easier for to mock the agg backend (e.g., in mplcairo).
Note that this is anyways only a shorthand for calling a method
(`.clear()`) on the renderer itself, so just issuing that call is just
as simple, more explicit, and can be done even when one just has access
to the renderer and not to the canvas (an admittedly rather hypothetical
case).
@anntzer
Copy link
Contributor Author
anntzer commented Jan 16, 2022

Oops, forgot to update it, fixed.

@timhoffm timhoffm merged commit 027dc6c into matplotlib:main Jan 16, 2022
@anntzer anntzer deleted the unclear branch January 16, 2022 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@timhoffm timhoffm timhoffm approved these changes

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
backend: agg
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.
3 participants
@anntzer @timhoffm @dstansby
0