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 /Lib/asyncio/runners.py | |
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 'Lib/asyncio/runners.py')
-rw-r--r-- | Lib/asyncio/runners.py | 6 |
1 files changed, 1 insertions, 5 deletions
diff --git a/Lib/asyncio/runners.py b/Lib/asyncio/runners.py index 904102b..03ce333 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(): |