Alter documentation to correctly state behavior (#2114)

Correctly document that the result of Condition.wait() is
not to raise a TimeoutError, but rather False.

diff --git a/tornado/locks.py b/tornado/locks.py
index 3ab55a6d7057275f35a980a8c589bdedf3755345..44222a43b23296374fe020f14076ea6fefc5fa87 100644 (file)
--- a/tornado/locks.py
+++ b/tornado/locks.py
@@ -99,8 +99,7 @@ class Condition(_TimeoutGarbageCollector):
         # Wait up to 1 second.
         yield condition.wait(timeout=datetime.timedelta(seconds=1))
 
-    The method raises `tornado.util.TimeoutError` if there's no notification
-    before the deadline.
+    The method returns False if there's no notification before the deadline.
 
     .. versionchanged:: 5.0
        Previously, waiters could be notified synchronously from within