]> granicus.if.org Git - python/commitdiff
Issue #23219: Update asyncio.wait_for() documentation
authorVictor Stinner <victor.stinner@gmail.com>
Fri, 3 Apr 2015 15:08:19 +0000 (17:08 +0200)
committerVictor Stinner <victor.stinner@gmail.com>
Fri, 3 Apr 2015 15:08:19 +0000 (17:08 +0200)
the wait is cancelled, the future *fut* is now also cancelled.

Doc/library/asyncio-task.rst

index 158a0d87842cd03f892f68efedfd7b6880078ab0..8392967318097a03a3600d3520bc66089ffa7004 100644 (file)
@@ -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.
+