]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
Doc coverage updates
authorBen Darnell <ben@bendarnell.com>
Sat, 29 Sep 2012 23:57:04 +0000 (16:57 -0700)
committerBen Darnell <ben@bendarnell.com>
Sat, 29 Sep 2012 23:57:04 +0000 (16:57 -0700)
tornado/ioloop.py
website/sphinx/ioloop.rst
website/sphinx/websocket.rst

index 236feaa418e580d55c9d242c74a559219ff4c424..3e32be34e4fc0175320848d90711bd792f87f948 100644 (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)
index 3e6e8ed3ae8df776ff83851d1a22b1f173d61fbd..a6f4819cada3f24e3ff4245424aca81a46387baf 100644 (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
index be7bbc542afc0d3926a409415aaae5204904873a..0b689440781a9e40f764ec30aa5a8579e162326b 100644 (file)
@@ -29,3 +29,5 @@
    -----
 
    .. automethod:: WebSocketHandler.async_callback
+   .. automethod:: WebSocketHandler.ping
+   .. automethod:: WebSocketHandler.on_pong