From a174578dfa9b7c45910e759cff1fbc4e82fd2ca7 Mon Sep 17 00:00:00 2001 From: Ben Darnell Date: Sun, 18 Mar 2018 22:55:02 -0400 Subject: [PATCH] gen: Doc touchups --- docs/gen.rst | 26 +++++++++++++++----------- tornado/gen.py | 3 --- 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/gen.rst b/docs/gen.rst index 1f1b2c1d7..0f0bfdeef 100644 --- a/docs/gen.rst +++ b/docs/gen.rst @@ -34,17 +34,6 @@ .. 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 @@ -70,3 +59,18 @@ .. 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. diff --git a/tornado/gen.py b/tornado/gen.py index 579939a19..cc59402e5 100644 --- a/tornado/gen.py +++ b/tornado/gen.py @@ -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 -- 2.47.3