diff options
| author | Victor Stinner <victor.stinner@gmail.com> | 2015-04-03 15:08:19 (GMT) |
|---|---|---|
| committer | Victor Stinner <victor.stinner@gmail.com> | 2015-04-03 15:08:19 (GMT) |
| commit | 72dcb0a7658c6dd99c2798b515c76e8cb311dbf6 (patch) | |
| tree | d86992acade76b9540eb702761a8c6e6a18c1f67 | |
| parent | 807743403d08cfbadfbb304832465b01fb3cf033 (diff) | |
| download | cpython-72dcb0a7658c6dd99c2798b515c76e8cb311dbf6.zip cpython-72dcb0a7658c6dd99c2798b515c76e8cb311dbf6.tar.gz cpython-72dcb0a7658c6dd99c2798b515c76e8cb311dbf6.tar.bz2 | |
Issue #23219: Update asyncio.wait_for() documentation
the wait is cancelled, the future *fut* is now also cancelled.
| -rw-r--r-- | Doc/library/asyncio-task.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 158a0d8..8392967 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -644,7 +644,12 @@ Task functions cancels the task and raises :exc:`asyncio.TimeoutError`. To avoid the task cancellation, wrap it in :func:`shield`. + If the wait is cancelled, the future *fut* is also cancelled. + This function is a :ref:`coroutine <coroutine>`, usage:: result = yield from asyncio.wait_for(fut, 60.0) + .. versionchanged:: 3.4.3 + If the wait is cancelled, the future *fut* is now also cancelled. + |