diff options
author | Kyle Stanley <aeros167@gmail.com> | 2019-10-01 00:12:21 (GMT) |
---|---|---|
committer | Yury Selivanov <yury@magic.io> | 2019-10-01 00:12:21 (GMT) |
commit | e407013089259e4c0b271703e1975bbcd578a2d5 (patch) | |
tree | fd024be219b30a36f50f5cbe166fbeca5f511822 /Doc/library | |
parent | aca8c406ada3bb547765b262bed3ac0cc6be8dd3 (diff) | |
download | cpython-e407013089259e4c0b271703e1975bbcd578a2d5.zip cpython-e407013089259e4c0b271703e1975bbcd578a2d5.tar.gz cpython-e407013089259e4c0b271703e1975bbcd578a2d5.tar.bz2 |
Fix and improve `asyncio.run()` docs (GH-16403)
Diffstat (limited to 'Doc/library')
-rw-r--r-- | Doc/library/asyncio-task.rst | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 9f55a35..155887a 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -212,6 +212,8 @@ Running an asyncio Program .. function:: run(coro, \*, debug=False) + Execute the :term:`coroutine` *coro* and return the result. + This function runs the passed coroutine, taking care of managing the asyncio event loop, *finalizing asynchronous generators*, and closing the threadpool. @@ -225,10 +227,6 @@ Running an asyncio Program the end. It should be used as a main entry point for asyncio programs, and should ideally only be called once. - Return a result of *coro* execution, or raise a :exc:`RuntimeError` - if ``asyncio.run()`` is called from a running event loop, or a - :exc:`ValueError` if *coro* is not a courutine. - Example:: async def main(): |