]> git.ipfire.org Git - thirdparty/tornado.git/commitdiff
gen: Doc touchups
authorBen Darnell <ben@bendarnell.com>
Mon, 19 Mar 2018 02:55:02 +0000 (22:55 -0400)
committerBen Darnell <ben@bendarnell.com>
Mon, 19 Mar 2018 03:33:04 +0000 (23:33 -0400)
docs/gen.rst
tornado/gen.py

index 1f1b2c1d7dafe642947c01ff7aeed345a6eede00..0f0bfdeefb70a249a0c4ddfbaea2d36af3bc38fb 100644 (file)
 
    .. autofunction:: multi_future
 
-   .. autofunction:: Task
-
-   .. class:: Arguments
-
-      The result of a `Task` or `Wait` whose callback had more than one
-      argument (or keyword arguments).
-
-      The `Arguments` object is a `collections.namedtuple` and can be
-      used either as a tuple ``(args, kwargs)`` or an object with attributes
-      ``args`` and ``kwargs``.
-
    .. autofunction:: convert_yielded
 
    .. autofunction:: maybe_future
    .. autoclass:: WaitAll
 
    .. autoclass:: MultiYieldPoint
+
+   .. autofunction:: Task
+
+   .. class:: Arguments
+
+      The result of a `Task` or `Wait` whose callback had more than one
+      argument (or keyword arguments).
+
+      The `Arguments` object is a `collections.namedtuple` and can be
+      used either as a tuple ``(args, kwargs)`` or an object with attributes
+      ``args`` and ``kwargs``.
+
+      .. deprecated:: 5.1
+
+         This class will be removed in 6.0.
index 579939a19f19c7b396636cfd8bac69b12a2761ae..cc59402e5ee9df10f9be2e2d6ddf305826cd437e 100644 (file)
@@ -261,9 +261,6 @@ def coroutine(func):
     ``callback`` argument is not visible inside the decorated
     function; it is handled by the decorator itself.
 
-    From the caller's perspective, ``@gen.coroutine`` is similar to
-    the combination of ``@return_future`` and ``@gen.engine``.
-
     .. warning::
 
        When exceptions occur inside a coroutine, the exception