From: A. Jesse Jiryu Davis <jesse@mongodb.com>
Date: Sat, 28 Mar 2015 10:02:32 +0000 (-0400)
Subject: Clarify event.wait's blocking behavior.
X-Git-Tag: v4.2.0b1~50^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1398%2Fhead;p=thirdparty%2Ftornado.git

Clarify event.wait's blocking behavior.
---

diff --git a/docs/locks.rst b/docs/locks.rst
index 3dbed192b..c9fd275c3 100644
--- a/docs/locks.rst
+++ b/docs/locks.rst
@@ -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::