summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorElvis Pranskevichus <elvis@magic.io>2018-05-29 22:21:44 (GMT)
committerYury Selivanov <yury@magic.io>2018-05-29 22:21:44 (GMT)
commitf9aeca2085464838f04bf13f816a1f861d43541f (patch)
treefcd34b75a6b592f1c09df5e1d3fa7369f044e557 /Doc/library
parente2b340ab4196e1beb902327f503574b5d7369185 (diff)
downloadcpython-f9aeca2085464838f04bf13f816a1f861d43541f.zip
cpython-f9aeca2085464838f04bf13f816a1f861d43541f.tar.gz
cpython-f9aeca2085464838f04bf13f816a1f861d43541f.tar.bz2
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.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/asyncio-task.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 3121b47..ba2cc12 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::