Hi everybody, Under the impulsion of Victor, we've started this morning a pre-sprint for AsyncIO Documentation for new comers: https://twitter.com/GMLudo/status/756425194995126272
The repository: https://github.com/haypo/asyncio-doc For the record, in fact, this monday at EuroPython, we did an AsyncIO helpdesk with Andrew Svetlov. We have a good frequentation the morning especially for a helpdesk (very cool), but a lot of attendees are confused about the actual documentation (less cool). They seem with a lot of good faith about the actual documentation that we discussed between us during the week to try to improve the actual situation. We continue that during the sprint this week-end. Have a nice week. -- Ludovic Gasc (GMLudo) http://www.gmludo.eu/ 2016-07-21 14:33 GMT+02:00 Victor Stinner <[email protected]>: > Hi, > > Many people came to me to ask me if there is an official tutorial or > if someone is working on it. Yury and Ludovic are interested to write > a very quick tutorial (like 2 pages) to really introduce the most > important features of asyncio in a single tutorial. > > There is a very complete explanation of asyncio, but too detailed for > a tutorial: > http://aosabook.org/en/500L/a-web-crawler-with-asyncio-coroutines.html > > Ludovic pointed me to a Twisted which he read to learn Twisted: > http://krondo.com/an-introduction-to-asynchronous-programming-and-twisted/ > > The question is where we should host the tutorial(s). There is an > HOWTO section in the Python documentation. > > I see an issue: in the Python documentation, we cannot refer to > external libraries like aiohttp, while in practice asyncio is almost > never used directly. Ludovic said that asyncio doc is written for > people writing libraries, not for *users* of these libraries. > > Maybe we should create a new documentation, separated from the Python > documentation, to be able to mention external libraries, but also to > ease contributions to this documentation. > > For example, I like https://packaging.python.org/ which has a clear > separation between two different use cases: (1) install a package (2) > build a package. > > Ideas? > > Victor >
