Skip to content

Commit

Permalink
Condition.wait examples should show timeout, not deadline.
Browse files Browse the repository at this point in the history
  • Loading branch information
ajdavis committed Apr 19, 2015
1 parent d167681 commit b2e81f6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tornado/locks.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,12 +95,12 @@ def runner():
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.
Expand Down

0 comments on commit b2e81f6

Please sign in to comment.