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

Skip to content

Widgets cleanup. #17124

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 14, 2020
Merged

Widgets cleanup. #17124

merged 1 commit into from
Apr 14, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 13, 2020

Mostly docstring cleanups, but also a small simplification to
_SelectorWidget._get_data.

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

Mostly docstring cleanups, but also a small simplification to
_SelectorWidget._get_data.
self._prev_event = event
return event

def press(self, event):
"""Button press handler and validator"""
"""Button press handler and validator."""
Copy link
Contributor

@dopplershift dopplershift Apr 13, 2020

Choose a reason for hiding this comment

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

Might we want to make this an actual sentence like: "Validate and handle a button press."?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I tend to think of these callbacks as nouns ("it's the event handler for yada yada") rather than verbs ("do this and that") -- after all, users generally use them as "objects" (passing them to mpl_connect) rather than actually calling them.

@QuLogic QuLogic merged commit 533bb57 into matplotlib:master Apr 14, 2020
@anntzer anntzer deleted the widgets branch April 14, 2020 07:22
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