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 | |
| parent | aca8c406ada3bb547765b262bed3ac0cc6be8dd3 (diff) | |
| download | cpython-e407013089259e4c0b271703e1975bbcd578a2d5.zip cpython-e407013089259e4c0b271703e1975bbcd578a2d5.tar.gz cpython-e407013089259e4c0b271703e1975bbcd578a2d5.tar.bz2 | |
Fix and improve `asyncio.run()` docs (GH-16403)
| -rw-r--r-- | Doc/glossary.rst | 2 | ||||
| -rw-r--r-- | Doc/library/asyncio-task.rst | 6 | ||||
| -rw-r--r-- | Lib/asyncio/runners.py | 6 |
3 files changed, 4 insertions, 10 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst index e601e8b..9ce0357 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -247,7 +247,7 @@ Glossary Fortran contiguous arrays, the first index varies the fastest. coroutine - Coroutines is a more generalized form of subroutines. Subroutines are + Coroutines are a more generalized form of subroutines. Subroutines are entered at one point and exited at another point. Coroutines can be entered, exited, and resumed at many different points. They can be implemented with the :keyword:`async def` statement. See also diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 9f55a35..155887a 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -212,6 +212,8 @@ Running an asyncio Program .. function:: run(coro, \*, debug=False) + Execute the :term:`coroutine` *coro* and return the result. + This function runs the passed coroutine, taking care of managing the asyncio event loop, *finalizing asynchronous generators*, and closing the threadpool. @@ -225,10 +227,6 @@ Running an asyncio Program 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(): 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(): |