diff options
| author | Elvis Pranskevichus <elvis@magic.io> | 2018-05-29 18:21:44 -0400 |
|---|---|---|
| committer | Yury Selivanov <yury@magic.io> | 2018-05-29 18:21:44 -0400 |
| commit | f9aeca2085464838f04bf13f816a1f861d43541f (patch) | |
| tree | fcd34b75a6b592f1c09df5e1d3fa7369f044e557 | |
| parent | e2b340ab4196e1beb902327f503574b5d7369185 (diff) | |
| download | cpython-git-f9aeca2085464838f04bf13f816a1f861d43541f.tar.gz | |
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.
| -rw-r--r-- | Doc/library/asyncio-task.rst | 3 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst | 1 |
2 files changed, 4 insertions, 0 deletions
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. |