From 03b00ae4a8c9c8ef9d70ff7dd01b93c67a361f3b Mon Sep 17 00:00:00 2001 From: Ben Darnell Date: Sat, 29 Sep 2012 16:57:04 -0700 Subject: [PATCH] Doc coverage updates --- tornado/ioloop.py | 2 ++ website/sphinx/ioloop.rst | 2 ++ website/sphinx/websocket.rst | 2 ++ 3 files changed, 6 insertions(+) diff --git a/tornado/ioloop.py b/tornado/ioloop.py index 236feaa4..3e32be34 100644 --- a/tornado/ioloop.py +++ b/tornado/ioloop.py @@ -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) diff --git a/website/sphinx/ioloop.rst b/website/sphinx/ioloop.rst index 3e6e8ed3..a6f4819c 100644 --- a/website/sphinx/ioloop.rst +++ b/website/sphinx/ioloop.rst @@ -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 diff --git a/website/sphinx/websocket.rst b/website/sphinx/websocket.rst index be7bbc54..0b689440 100644 --- a/website/sphinx/websocket.rst +++ b/website/sphinx/websocket.rst @@ -29,3 +29,5 @@ ----- .. automethod:: WebSocketHandler.async_callback + .. automethod:: WebSocketHandler.ping + .. automethod:: WebSocketHandler.on_pong