diff options
author | Yury Selivanov <yury@magic.io> | 2018-09-14 20:32:07 (GMT) |
---|---|---|
committer | Carol Willing <carolcode@willingconsulting.com> | 2018-09-14 20:32:07 (GMT) |
commit | 3faaa8857a42a36383bb18425444e597fc876797 (patch) | |
tree | 109c2997624aba5ed64b619938a6ca8a7bf007c1 /Doc/library/asyncio.rst | |
parent | ad8a0004206ba7aec5a8a60fce413da718080db2 (diff) | |
download | cpython-3faaa8857a42a36383bb18425444e597fc876797.zip cpython-3faaa8857a42a36383bb18425444e597fc876797.tar.gz cpython-3faaa8857a42a36383bb18425444e597fc876797.tar.bz2 |
bpo-33649: Refresh Tasks and Futures pages (#9314)
* bpo-33649: Refresh Tasks and Futures pages
* Fixes
* Fix markup
Diffstat (limited to 'Doc/library/asyncio.rst')
-rw-r--r-- | Doc/library/asyncio.rst | 49 |
1 files changed, 31 insertions, 18 deletions
diff --git a/Doc/library/asyncio.rst b/Doc/library/asyncio.rst index 0d58a94..2c8ccbb 100644 --- a/Doc/library/asyncio.rst +++ b/Doc/library/asyncio.rst @@ -1,15 +1,13 @@ -:mod:`asyncio` --- Asynchronous I/O, event loop, coroutines and tasks -===================================================================== +:mod:`asyncio` --- Asynchronous I/O +=================================== .. module:: asyncio - :synopsis: Asynchronous I/O, event loop, coroutines and tasks. - -.. versionadded:: 3.4 - -**Source code:** :source:`Lib/asyncio/` + :synopsis: Asynchronous I/O. -------------- +.. TODO: rewrite the introduction section + This module provides infrastructure for writing single-threaded concurrent code using coroutines, multiplexing I/O access over sockets and other resources, running network clients and servers, and other related primitives. @@ -44,25 +42,40 @@ programming: see the :ref:`Develop with asyncio <asyncio-dev>` page which lists common traps and explains how to avoid them. :ref:`Enable the debug mode <asyncio-debug-mode>` during development to detect common issues. -Table of contents: +High-level APIs: .. toctree:: - :maxdepth: 3 + :maxdepth: 1 - asyncio-eventloop.rst - asyncio-policy.rst - asyncio-platforms.rst asyncio-task.rst - asyncio-protocol.rst asyncio-stream.rst - asyncio-subprocess.rst asyncio-sync.rst + asyncio-subprocess.rst asyncio-queue.rst - asyncio-dev.rst asyncio-exceptions.rst -.. seealso:: +Low-level APIs: + +.. toctree:: + :maxdepth: 1 - The :mod:`asyncio` module was designed in :PEP:`3156`. For a - motivational primer on transports and protocols, see :PEP:`3153`. + asyncio-eventloop.rst + asyncio-future.rst + asyncio-protocol.rst + asyncio-policy.rst + asyncio-platforms.rst + +Guides and Tutorials: + +.. toctree:: + :maxdepth: 1 + + asyncio-dev.rst + + +.. seealso:: + The :mod:`asyncio` module was proposed in :PEP:`3156`. + Since the acceptance of the PEP many new APIs were added and many + original APIs were altered. The PEP should be treated as a + historical document. |