From: Ben Darnell Date: Sat, 29 Sep 2012 23:57:04 +0000 (-0700) Subject: Doc coverage updates X-Git-Tag: v3.0.0~261 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=03b00ae4a8c9c8ef9d70ff7dd01b93c67a361f3b;p=thirdparty%2Ftornado.git Doc coverage updates --- diff --git a/tornado/ioloop.py b/tornado/ioloop.py index 236feaa41..3e32be34e 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 3e6e8ed3a..a6f4819ca 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 be7bbc542..0b6894407 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