Browse files

Doc coverage updates

  • Loading branch information...
1 parent 5f5aae9 commit 03b00ae4a8c9c8ef9d70ff7dd01b93c67a361f3b @bdarnell bdarnell committed Sep 29, 2012
Showing with 6 additions and 0 deletions.
  1. +2 −0 tornado/ioloop.py
  2. +2 −0 website/sphinx/ioloop.rst
  3. +2 −0 website/sphinx/websocket.rst
View
2 tornado/ioloop.py
@@ -522,6 +522,8 @@ def add_callback_from_signal(self, callback):
_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
2 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
View
2 website/sphinx/websocket.rst
@@ -29,3 +29,5 @@
-----
.. automethod:: WebSocketHandler.async_callback
+ .. automethod:: WebSocketHandler.ping
+ .. automethod:: WebSocketHandler.on_pong

0 comments on commit 03b00ae

Please sign in to comment.