diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2019-09-25 02:12:47 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-09-25 02:12:47 -0700 |
| commit | 4633355a063c7bf068bdd72dfdd32f4c22cf382f (patch) | |
| tree | 85967ece50af6dc95278dc0b2c23105a95cb020f /Lib/asyncio | |
| parent | ce62dcc460cf88f663c34c4a0948c1ee1dc53f4d (diff) | |
| download | cpython-git-4633355a063c7bf068bdd72dfdd32f4c22cf382f.tar.gz | |
bpo-38260: Add Docs on asyncio.run (GH-16337)
Add docs about return and raise exception on asyncio.run
https://bugs.python.org/issue38260
Automerge-Triggered-By: @asvetlov
(cherry picked from commit 17deb16883fa574a86e42551cc37f044182347ad)
Co-authored-by: Emmanuel Arias <emmanuelarias30@gmail.com>
Diffstat (limited to 'Lib/asyncio')
| -rw-r--r-- | Lib/asyncio/runners.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Lib/asyncio/runners.py b/Lib/asyncio/runners.py index 5fbab03dd0..df686386b8 100644 --- a/Lib/asyncio/runners.py +++ b/Lib/asyncio/runners.py @@ -21,6 +21,10 @@ 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(): |