From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 30 May 2018 01:26:22 +0000 (-0700)
Subject: [3.7] bpo-23859: Document that asyncio.wait() does not cancel its futures (GH-7217... 
X-Git-Tag: v3.7.0b5~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f95269404c03bd769a3551cd851b51b8f89672df;p=thirdparty%2FPython%2Fcpython.git

[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 <elvis@magic.io>

* Update asyncio-task.rst
---

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 3121b4718332..2b480d4be3fb 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 <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 000000000000..b372faa5eb97
--- /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.