summaryrefslogtreecommitdiffstats
path: root/Lib/asyncio
diff options
context:
space:
mode:
authorEmmanuel Arias <emmanuelarias30@gmail.com>2019-09-25 08:53:49 (GMT)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-09-25 08:53:49 (GMT)
commit17deb16883fa574a86e42551cc37f044182347ad (patch)
tree2c74082e2cb28aeeff4714b1db8f1ed4bd4e91b9 /Lib/asyncio
parent57dc7d5ae8ebfb6da1ea2b25e61260ecb9c79faf (diff)
downloadcpython-17deb16883fa574a86e42551cc37f044182347ad.zip
cpython-17deb16883fa574a86e42551cc37f044182347ad.tar.gz
cpython-17deb16883fa574a86e42551cc37f044182347ad.tar.bz2
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
Diffstat (limited to 'Lib/asyncio')
-rw-r--r--Lib/asyncio/runners.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/Lib/asyncio/runners.py b/Lib/asyncio/runners.py
index 6c87747..904102b 100644
--- a/Lib/asyncio/runners.py
+++ b/Lib/asyncio/runners.py
@@ -21,6 +21,10 @@ def run(main, *, debug=False):
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 RuntimeError
+ if `asyncio.run()`is called from a running event loop, or a ValueError
+ if `main` is not a courutine.
+
Example:
async def main():