From bab223b842c4cd50151c8fa5edebd8f1f5578ef0 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Sun, 12 May 2019 11:28:19 +0200 Subject: [PATCH] Backport PR #14188: Clarify scope of MouseEvent attributes --- lib/matplotlib/backend_bases.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py index 04541c386521..08357ab0b99a 100644 --- 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 --------