8000 Backport PR #14188: Clarify scope of MouseEvent attributes · meeseeksmachine/matplotlib@bab223b · GitHub
[go: up one dir, main page]

Skip to content

Commit bab223b

Browse files
timhoffmMeeseeksDev[bot]
authored andcommitted
Backport PR matplotlib#14188: Clarify scope of MouseEvent attributes
1 parent da977d6 commit bab223b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/matplotlib/backend_bases.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1410,9 +1410,12 @@ class MouseEvent(LocationEvent):
14101410
14111411
step : scalar
14121412
The number of scroll steps (positive for 'up', negative for 'down').
1413+
This applies only to 'scroll_event' and defaults to 0 otherwise.
14131414
14141415
dblclick : bool
1415-
Whether the event is a double-click.
1416+
Whether the event is a double-click. This applies only to
1417+
'button_press_event' and is False otherwise. In particular, it's
1418+
not used in 'button_release_event'.
14161419
14171420
Examples
14181421
--------

0 commit comments

Comments
 (0)
0