Skip to content

Fix and improve asyncio.run() docs #16403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Oct 1, 2019
Merged

Fix and improve asyncio.run() docs #16403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
78bf148
Fix `asyncio.run()` docs
aeros Sep 25, 2019
8af372a
Fix `asyncio.run()` docstring
aeros Sep 25, 2019
c891adb
Add suggestion from @1st1
aeros Sep 27, 2019
b37528f
Add suggestion from @1st1
aeros Sep 27, 2019
360bc27
Fix spacing
aeros Sep 27, 2019
d69b7f9
Fix indent
aeros Sep 27, 2019
39b2f99
Reformat `asynco.run()` docs
aeros Sep 27, 2019
00e45fc
Reformat `asyncio.run()` docstring
aeros Sep 27, 2019
0d36a68
Remove extra space
aeros Sep 27, 2019
b48faa4
Adjust `asyncio.run()` docstring
aeros Sep 27, 2019
0aff627
Fix typo in glossary entry for coroutine
aeros Sep 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Doc/glossary.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 2 additions & 4 deletions Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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():
Expand Down
6 changes: 1 addition & 5 deletions Lib/asyncio/runners.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@


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
Expand All @@ -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():
Expand Down