]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
Clarify event.wait's blocking behavior. 1398/head
authorA. Jesse Jiryu Davis <jesse@mongodb.com>
Sat, 28 Mar 2015 10:02:32 +0000 (06:02 -0400)
committerA. Jesse Jiryu Davis <jesse@mongodb.com>
Sat, 28 Mar 2015 10:02:32 +0000 (06:02 -0400)
docs/locks.rst

index 3dbed192b077ae08db30775da9cc1002171a7d97..c9fd275c3a80e0d338f140de002005144240946c 100644 (file)
@@ -76,8 +76,8 @@ multithreaded app.)*
    .. autoclass:: Event
     :members:
 
-    A coroutine can wait for an event to be set. Once it is set, the coroutine
-    does not block on `wait` until the the event is unset again:
+    A coroutine can wait for an event to be set. Once it is set, calls to
+    ``yield event.wait()`` will not block unless the event has been cleared:
 
     .. testcode::