From: David Walker <dave@mudsite.com>
Date: Sun, 14 Jan 2018 00:01:51 +0000 (-0700)
Subject: Alter documentation to correctly state behavior (#2114)
X-Git-Tag: v5.0.0~17
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3e10b90e162c5b2548d7dd0b8ef9a138999b3d23;p=thirdparty%2Ftornado.git

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 3ab55a6d7..44222a43b 100644
--- 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