bpo-38260: Add Docs on asyncio.run (GH-16337)
Add docs about return and raise exception on asyncio.run
https://bugs.python.org/issue38260
Automerge-Triggered-By: @asvetlov
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 1fb8829..9f55a35 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -225,6 +225,18 @@
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():
+ await asyncio.sleep(1)
+ print('hello')
+
+ asyncio.run(main())
+
.. versionadded:: 3.7
.. versionchanged:: 3.9