aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPeter Hinch2020-04-08 09:55:32 +0100
committerDamien George2020-04-09 22:11:13 +1000
commit740946736186946fc0609c5bdb4d63c236d93017 (patch)
treea9dfe030ce6033af278a21b83eece0258a87cf26 /docs
parentd6f80963df501766fdb120069445f08b9d6165be (diff)
docs/library: Note that uasyncio.wait_for() can raise exception.
Diffstat (limited to 'docs')
-rw-r--r--docs/library/uasyncio.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/library/uasyncio.rst b/docs/library/uasyncio.rst
index 641fa3345..9cb0ca9bb 100644
--- a/docs/library/uasyncio.rst
+++ b/docs/library/uasyncio.rst
@@ -67,6 +67,9 @@ Additional functions
that *timeout* seconds. If *awaitable* is not a task then a task will be
created from it.
+ If a timeout occurs, it cancels the task and raises ``asyncio.TimeoutError``:
+ this should be trapped by the caller.
+
Returns the return value of *awaitable*.
This is a coroutine.