Merge pull request #14196 from meeseeksmachine/auto-backport-of-pr-14188-on-v3.1.x

timhoffm · web-flow · commit 267aa4e07847 · 2019-05-12T12:53:41.000+02:00
Backport PR #14188 on branch v3.1.x (Clarify scope of MouseEvent attributes)
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1410,9 +1410,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'.
 
     Examples
     --------
