document assert_correct_key

matplotlib · Sep 19, 2013 · 989ce39 · 989ce39
1 parent ec40639
commit 989ce39
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lib/matplotlib/tests/test_backend_qt4.py b/lib/matplotlib/tests/test_backend_qt4.py
@@ -50,6 +50,12 @@ def test_fig_close():
 
 
 def assert_correct_key(qt_key, qt_mods, answer):
+    """
+    Make a figure
+    Send a key_press_event event (using non-public, qt4 backend specific api)
+    Catch the event
+    Assert sent and caught keys are the same
+    """
     plt.switch_backend('Qt4Agg')
     qt_canvas = plt.figure().canvas