Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Deprecate ScalarMappable.check_update and associated machinery. #17166

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
Apr 17, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 17, 2020

It's a rather complex machinery that's ultimately just used by
Collection to know whether the alpha array has been updated so that the
value-to-rgba mapping needs to be updated. Users can't connect to it to
know whether the mapped values have been updated, and they can't even
use it to check whether the alpha values have been updated because
this unsets the marker and thus would mess up Collection's own use of
it. For now, just deprecate its public use to ultimately make it
private and perhaps replace it later by something less brittle (e.g.,
normal a normal callback registry).

PR Summary

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

@anntzer anntzer added this to the v3.3.0 milestone Apr 17, 2020
Copy link
Member

@efiring efiring left a comment

Choose a reason for hiding this comment

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

Blame shows I put this in 13 years ago, and as the PR notes, it is barely used within mpl. I'm happy to see it deprecated now and eventually replaced.

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.

After typo fix.

It's a rather complex machinery that's ultimately just used by
Collection to know whether the alpha array has been updated so that the
value-to-rgba mapping needs to be updated.  Users can't connect to it to
know whether the mapped values have been updated, and they can't even
use it to check whether the *alpha* values have been updated because
this unsets the marker and thus would mess up Collection's own use of
it.  For now, just deprecate its public use to ultimately make it
private and perhaps replace it later by something less brittle (e.g.,
normal a normal callback registry).
@anntzer
Copy link
Contributor Author

anntzer commented Apr 17, 2020

typo fixed

@QuLogic QuLogic merged commit d971c59 into matplotlib:master Apr 17, 2020
@anntzer anntzer deleted the updatedict branch April 17, 2020 22:24
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.

4 participants