Skip to content

Clarify scope of MouseEvent attributes #14188

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

Merged
merged 1 commit into from
May 12, 2019
Merged

Clarify scope of MouseEvent attributes #14188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion lib/matplotlib/backend_bases.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1409,9 +1409,12 @@ class MouseEvent(LocationEvent):

step : scalar
The number of scroll steps (positive for 'up', negative for 'down').
This applies only to 'scroll_event' and defaults to 0 otherwise.

dblclick : bool
Whether the event is a double-click.
Whether the event is a double-click. This applies only to
'button_press_event' and is False otherwise. In particular, it's
not used in 'button_release_event'.
Copy link
Contributor

@anntzer anntzer May 11, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

"not used" -> "never set"? "always False"?

Copy link
Member Author

Choose a reason for hiding this comment

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

Mhh, these don't really match my intention. "never set" and "always False" both sound like the value is still meaningful but has a fixed value. I really would like to emphsize that for button_release_event dblclick is not part of the logic/API.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not clear to me whether "not used" means "the attribute does not exist" or "the attribute exists but can take any value, which is meaningless" (well I guess that's more a problem in C (uninitialized variable)) or "is always False".
Anyways, it's not a big deal, feel free to self-merge if you're not going to change this.

Copy link
Member Author

Choose a reason for hiding this comment

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

Going to merge as is since I don't have an idea how to express this more clearly without getting very verbose. Anyway, it's an improvement.


Examples
--------
Expand Down