Doc coverage updates

This commit is contained in:
Ben Darnell 2012-09-29 16:57:04 -07:00
parent 5f5aae9d57
commit 03b00ae4a8
3 changed files with 6 additions and 0 deletions

View File

@ -522,6 +522,8 @@ class IOLoop(object):
_FUTURE_TYPES = DummyFuture
def add_future(self, future, callback):
"""Schedules a callback on the IOLoop when the given future is finished.
The callback is invoked with one argument, the future.
"""
assert isinstance(future, IOLoop._FUTURE_TYPES)
callback = stack_context.wrap(callback)

View File

@ -30,6 +30,8 @@
^^^^^^^^
.. automethod:: IOLoop.add_callback
.. automethod:: IOLoop.add_callback_from_signal
.. automethod:: IOLoop.add_future
.. automethod:: IOLoop.add_timeout
.. automethod:: IOLoop.remove_timeout
.. autoclass:: PeriodicCallback

View File

@ -29,3 +29,5 @@
-----
.. automethod:: WebSocketHandler.async_callback
.. automethod:: WebSocketHandler.ping
.. automethod:: WebSocketHandler.on_pong