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 3121b4718332bc7f0f949ecd6fe4cbd401ed280e..ba2cc12a8a754b65f332f8d17493185aae39127b 100644 (file)
--- 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 (file)
index 0000000..b372faa
--- /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.