From f95269404c03bd769a3551cd851b51b8f89672df Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Tue, 29 May 2018 18:26:22 -0700 Subject: [PATCH] [3.7] bpo-23859: Document that asyncio.wait() does not cancel its futures (GH-7217) (#7227) * bpo-23859: Document that asyncio.wait() does not cancel its futures (GH-7217) Unlike `asyncio.wait_for()`, `asyncio.wait()` does not cancel the passed futures when a timeout accurs. (cherry picked from commit f9aeca2085464838f04bf13f816a1f861d43541f) Co-authored-by: Elvis Pranskevichus * Update asyncio-task.rst --- Doc/library/asyncio-task.rst | 3 +++ .../Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst | 1 + 2 files changed, 4 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 3121b47183..2b480d4be3 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 occurs. + This function is a :ref:`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. -- 2.50.0