Skip to content

Consistently name callback arguments event instead of evt #16099

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
Feb 13, 2020
Merged

Consistently name callback arguments event instead of evt #16099

merged 1 commit into from
Feb 13, 2020

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Jan 4, 2020

PR Summary

Changes are only made to examples and internal methods, so no deprecation necessary.

This addresses:

@timhoffm timhoffm added this to the v3.3.0 milestone Jan 4, 2020
anntzer
anntzer approved these changes Jan 4, 2020
View reviewed changes
Copy link
Contributor

@anntzer anntzer left a comment

Choose a reason for hiding this comment

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

postci

@dopplershift
Copy link
Contributor

I found some more evt in:

  • examples/event_handling/close_event.py
  • examples/user_interfaces/svg_tooltip_sgskip.py
  • lib/matplotlib/legend.py
  • lib/matplotlib/offsetbox.py

Did you exclude these intentionally?

@timhoffm
Copy link
Member Author

timhoffm commented Jan 5, 2020

  • examples/event_handling/close_event.py - was already covered in Cleanup unused variables #16097. But moved here for consistency.
  • examples/user_interfaces/svg_tooltip_sgskip.py - in text for javascript. Didn't want to look into this, but turns out it could easily changed as well.

The following occurrences are in technically public functions. If we go by the book, we would need a deprecation (even though I think hardly anybody will use these, and even less so with evt as kwarg). I couldn't decide if adding all the deprecations is worth it or if I just replace them and hope the best. So left that for now.

  • lib/matplotlib/legend.py
  • lib/matplotlib/offsetbox.py

@anntzer anntzer mentioned this pull request Jan 5, 2020
Merged
6 tasks
@timhoffm
Copy link
Member Author

ping @dopplershift I've addressed your concerns as far as possible.

@dopplershift dopplershift merged commit 2d11024 into matplotlib:master Feb 13, 2020
@timhoffm timhoffm deleted the event branch February 13, 2020 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dopplershift dopplershift dopplershift approved these changes

@anntzer anntzer anntzer approved these changes

Assignees
No one assigned
Labels
API: consistency
Projects
None yet
Milestone
v3.3.0
Development

Successfully merging this pull request may close these issues.
4 participants
@timhoffm @dopplershift @anntzer @QuLogic