From e461d7564fe41d481c579c711e32ab88c124f015 Mon Sep 17 00:00:00 2001 From: Antony Lee Date: Tue, 24 Oct 2017 00:51:51 -0700 Subject: [PATCH] Docstring fix. --- lib/matplotlib/backend_bases.py | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py index d7c6e61e6c95..0171b3e55661 100644 --- a/lib/matplotlib/backend_bases.py +++ b/lib/matplotlib/backend_bases.py @@ -2644,6 +2644,12 @@ class FigureManagerBase(object): num : int or str The figure number + key_press_handler_id : int + The default key handler cid, when using the toolmanager. Can be used + to disable default key press handling :: + + figure.canvas.mpl_disconnect( + figure.canvas.manager.key_press_handler_id) """ def __init__(self, canvas, num): self.canvas = canvas @@ -2651,16 +2657,6 @@ def __init__(self, canvas, num): self.num = num self.key_press_handler_id = None - """ - The returned id from connecting the default key handler via - :meth:`FigureCanvasBase.mpl_connect`. - - To disable default key press handling:: - - manager, canvas = figure.canvas.manager, figure.canvas - canvas.mpl_disconnect(manager.key_press_handler_id) - - """ if rcParams['toolbar'] != 'toolmanager': self.key_press_handler_id = self.canvas.mpl_connect( 'key_press_event',