Merge pull request #1493 from minrk/retFalse

dopplershift · dopplershift · commit 0da885a61558 · 2012-11-26T19:19:48.000-08:00
Fix coercion of values to False in _on_timer() introduced in PEP8 clean-up. Fixes #1492.
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -1118,12 +1118,14 @@ def _timer_set_single_shot(self):
     def _on_timer(self):
         '''
         Runs all function that have been registered as callbacks. Functions
-        can return False if they should not be called any more. If there
+        can return False (or 0) if they should not be called any more. If there
         are no callbacks, the timer is automatically stopped.
         '''
         for func, args, kwargs in self.callbacks:
             ret = func(*args, **kwargs)
-            if not ret:
+            # docstring above explains why we use `if ret == False` here,
+            # instead of `if not ret`.
+            if ret == False:
                 self.callbacks.remove((func, args, kwargs))
 
         if len(self.callbacks) == 0:
