summaryrefslogtreecommitdiffstats
path: root/Lib/asyncio
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2019-10-01 01:46:43 (GMT)
committerYury Selivanov <yury@magic.io>2019-10-01 01:46:43 (GMT)
commit2f644c0dc951868181e380f3d1cb4854e3a3152e (patch)
tree9383d03701797cba03a32027a3e227102942c52b /Lib/asyncio
parentbdace21b769998396d0ccc8da99a8ca9b507bfdf (diff)
downloadcpython-2f644c0dc951868181e380f3d1cb4854e3a3152e.zip
cpython-2f644c0dc951868181e380f3d1cb4854e3a3152e.tar.gz
cpython-2f644c0dc951868181e380f3d1cb4854e3a3152e.tar.bz2
Fix and improve `asyncio.run()` docs (GH-16403) (GH-16504)
(cherry picked from commit e407013089259e4c0b271703e1975bbcd578a2d5) Co-authored-by: Kyle Stanley <aeros167@gmail.com>
Diffstat (limited to 'Lib/asyncio')
-rw-r--r--Lib/asyncio/runners.py6
1 files changed, 1 insertions, 5 deletions
diff --git a/Lib/asyncio/runners.py b/Lib/asyncio/runners.py
index df68638..2e37e18 100644
--- a/Lib/asyncio/runners.py
+++ b/Lib/asyncio/runners.py
@@ -6,7 +6,7 @@ from . import tasks
def run(main, *, debug=False):
- """Run a coroutine.
+ """Execute the coroutine and return the result.
This function runs the passed coroutine, taking care of
managing the asyncio event loop and finalizing asynchronous
@@ -21,10 +21,6 @@ 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():