Document cancelation semantics for as_completed

2022-02-06 23:52:10 -08:00 · 2022-02-06 23:52:10 -08:00 · 1150d47678
parent 42367d18ef
commit 1150d47678
1 changed files with 3 additions and 0 deletions
--- a/aioitertools/asyncio.py
+++ b/aioitertools/asyncio.py
@ -29,6 +29,9 @@ async def as_completed(
    Unlike `asyncio.as_completed`, this yields actual results, and does not require
    awaiting each item in the iterable.

+    Cancels all remaining awaitables if a timeout is given and the timeout threshold
+    is reached.
+
    Example::

        async for value in as_completed(futures):