From: A. Jesse Jiryu Davis <jesse@mongodb.com>
Date: Sun, 19 Apr 2015 02:40:34 +0000 (-0400)
Subject: Condition.wait examples should show timeout, not deadline.
X-Git-Tag: v4.2.0b1~17^2~1
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b2e81f6bfa563527ca802cc51d347f4863f563a2;p=thirdparty%2Ftornado.git

Condition.wait examples should show timeout, not deadline.
---

diff --git a/tornado/locks.py b/tornado/locks.py
index 914187c97..77340abcc 100644
--- a/tornado/locks.py
+++ b/tornado/locks.py
@@ -95,12 +95,12 @@ class Condition(_TimeoutGarbageCollector):
         io_loop = ioloop.IOLoop.current()
 
         # Wait up to 1 second for a notification.
-        yield condition.wait(deadline=io_loop.time() + 1)
+        yield condition.wait(timeout=io_loop.time() + 1)
 
-    ...or a `datetime.timedelta` for a deadline relative to the current time::
+    ...or a `datetime.timedelta` for a timeout relative to the current time::
 
         # Wait up to 1 second.
-        yield condition.wait(deadline=datetime.timedelta(seconds=1))
+        yield condition.wait(timeout=datetime.timedelta(seconds=1))
 
     The method raises `tornado.gen.TimeoutError` if there's no notification
     before the deadline.