[docs] [issue33649] asyncio docs overhaul

Yury Selivanov report at bugs.python.org
Fri May 25 15:48:42 EDT 2018

New submission from Yury Selivanov <yselivanov at gmail.com>:

An overhaul of asyncio documentation is long overdue.  Here's the structure for it that I have in mind:

- Introduction
(what is asyncio and async/await)

- A quick tutorial
(show how to use asyncio.run() and basic functions like asyncio.sleep() and teach that asyncio programs are all about async/await and *not* about callbacks or event loops)

- High-level APIs
(Tasks, Streams, Subprocesses, few other functions)

- Low-level APIs
  - Preface (talk a bit about everything: what's an event loop, what is a Future and a Transport)
  - Futures
  - Event loop APIs
  - Transports and Protocols (when to use and when not to use them)

- Tutorials
  - High-level networking server
  - HTTP application
  - Low-level protocol implementation using Transports
  - etc

assignee: docs at python
components: Documentation, asyncio
messages: 317709
nosy: akuchling, asvetlov, docs at python, yselivanov
priority: normal
severity: normal
status: open
title: asyncio docs overhaul
type: enhancement
versions: Python 3.7, Python 3.8

Python tracker <report at bugs.python.org>

More information about the docs mailing list