From: Elvis Pranskevichus <elvis@magic.io> Date: Tue, 29 May 2018 22:21:44 +0000 (-0400) Subject: bpo-23859: Document that asyncio.wait() does not cancel its futures (#7217) X-Git-Tag: v3.8.0a1~1724 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f9aeca2085464838f04bf13f816a1f861d43541f;p=python bpo-23859: Document that asyncio.wait() does not cancel its futures (#7217) Unlike `asyncio.wait_for()`, `asyncio.wait()` does not cancel the passed futures when a timeout accurs. --- diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 3121b47183..ba2cc12a8a 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -768,6 +768,9 @@ Task functions | | futures finish or are cancelled. | +-----------------------------+----------------------------------------+ + Unlike :func:`~asyncio.wait_for`, ``wait()`` will not cancel the futures + when a timeout accurs. + This function is a :ref:`coroutine <coroutine>`. Usage:: diff --git a/Misc/NEWS.d/next/Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst b/Misc/NEWS.d/next/Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst new file mode 100644 index 0000000000..b372faa5eb --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst @@ -0,0 +1 @@ +Document that `asyncio.wait()` does not cancel its futures on timeout.