Clarify scope of MouseEvent attributes #14188
Conversation
| 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'. |
There was a problem hiding this comment.
"not used" -> "never set"? "always False"?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
…188-on-v3.1.x Backport PR #14188 on branch v3.1.x (Clarify scope of MouseEvent attributes)
PR Summary
MouseEventis a generic class for all mouse events. Some of its attributes do not have a meaning for specific events. This PR documents that.Closes #4001.