[docs] Feedback for awaitable coroutine documentation (issue 24439)

vadmium+py at gmail.com vadmium+py at gmail.com
Wed Jun 24 00:36:43 CEST 2015


http://bugs.python.org/review/24439/diff/15143/Doc/library/asyncio-task.rst
File Doc/library/asyncio-task.rst (right):

http://bugs.python.org/review/24439/diff/15143/Doc/library/asyncio-task.rst#newcode16
Doc/library/asyncio-task.rst:16: :func:`@asyncio.coroutine
<asyncio.coroutine>`.  This is mainly
On 2015/06/23 18:51:10, Yury.Selivanov wrote:
> I'd say that it's encouraged to use the decorator on generator-based
coroutine
> functions for documentation purposes *and* for compatibility with PEP
492
> coroutines.

Okay. I need to mention the compatibility works in both directions.

http://bugs.python.org/review/24439/diff/15143/Doc/library/asyncio-task.rst#newcode94
Doc/library/asyncio-task.rst:94: async def hello_world():
On 2015/06/23 18:51:10, Yury.Selivanov wrote:
> I think we should leave one example of generator based coroutines...

Perhaps duplicate the second one, to contrast “await” with “yield from”.

http://bugs.python.org/review/24439/diff/15143/Objects/genobject.c
File Objects/genobject.c (right):

http://bugs.python.org/review/24439/diff/15143/Objects/genobject.c#newcode913
Objects/genobject.c:913: {"close",(PyCFunction)coro_wrapper_close,
METH_NOARGS, coro_close_doc},
On 2015/06/23 18:51:10, Yury.Selivanov wrote:
> Please rebase your patch -- this code was updated in 24400.

This patch is actually based on revision 44253ce374fc (your #24400
commit into the default branch). It _added_ the coro_wrapper_methods,
but they refer to the generator doc strings, not the coroutine doc
strings. I can’t see anywhere that they have been _updated_, so rebasing
won’t do anything (unless you’re sitting on code that you forgot to
commit).

http://bugs.python.org/review/24439/


More information about the docs mailing list