MNT: Deprecate figure callbacks #22813
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jklymak
approved these changes
Apr 9, 2022
tacaswell
reviewed
Apr 9, 2022
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
| The figure callbacks property is deprecated. The only signal was | ||
| "dpi_changed", which can be replaced by connecting to the "resize_event" | ||
| on ``figure.canvas.callbacks`` instead. |
There was a problem hiding this comment.
Should this point to canvas.mpl_connect instead?
There was a problem hiding this comment.
Sure, I updated the doc. canvas.mpl_connect is simply an alias for canvas.callbacks.connect it looks like. I guess mpl_connect is preferred?
This removes callbacks from the figure level. It only allowed the dpi_changed signal, which is not used anywhere in the library.
b569912 to
6a1b8c6
Compare
anntzer
approved these changes
Apr 17, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This removes callbacks from the figure level. It only allowed the "dpi_changed" signal, which is not used anywhere in the library anymore after #22807
A quick note that
resize_eventis apparently not always emitted on a dpi change, but forcing it withself.canvas.resize_event()triggers some other test failures, so I'm not sure we want to send that signal within the dpi change routine either. I think this is more of a messaging thing in what do we want to list as an alternative rather than a show-stopper and needing to keep this signal around.PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).