Fix and improve `asyncio.run()` docs (GH-16403) (GH-16504)
(cherry picked from commit e407013089
)
Co-authored-by: Kyle Stanley <aeros167@gmail.com>
This commit is contained in:
parent
bdace21b76
commit
2f644c0dc9
|
@ -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
|
||||
|
|
|
@ -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 and *finalizing asynchronous
|
||||
generators*.
|
||||
|
@ -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():
|
||||
|
|
|
@ -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():
|
||||
|
|
Loading…
Reference in New Issue