summaryrefslogtreecommitdiff
path: root/Lib/asyncio/runners.py
diff options
context:
space:
mode:
Diffstat (limited to 'Lib/asyncio/runners.py')
-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 5fbab03dd0..df686386b8 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():