From 740946736186946fc0609c5bdb4d63c236d93017 Mon Sep 17 00:00:00 2001 From: Peter Hinch Date: Wed, 8 Apr 2020 09:55:32 +0100 Subject: [PATCH] docs/library: Note that uasyncio.wait_for() can raise exception. --- docs/library/uasyncio.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/library/uasyncio.rst b/docs/library/uasyncio.rst index 641fa33457..9cb0ca9bb9 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.