[Python-Dev] Fwd: [python-tulip] Need help to finish asyncio documentation

[MRAB]

On 2014-02-08 23:32, Guido van Rossum wrote:
> We could really use more help reviewing and finishing asyncio's docs!
>
Some spelling mistakes:

http://docs.python.org/dev/library/asyncio.html
mimicks

http://docs.python.org/dev/library/asyncio-task.html
returing
nummber

http://docs.python.org/dev/library/asyncio-protocol.html
correspondong

http://docs.python.org/dev/library/asyncio-stream.html
Sublclass

http://docs.python.org/dev/library/asyncio-subprocess.html
subproces
signale

> ---------- Forwarded message ----------
> From: *Victor Stinner* <victor.stinner at gmail.com
> <mailto:victor.stinner at gmail.com>>
> Date: Sat, Feb 8, 2014 at 2:38 PM
> Subject: [python-tulip] Need help to finish asyncio documentation
> To: python-tulip <python-tulip at googlegroups.com
> <mailto:python-tulip at googlegroups.com>>
>
>
> Hi,
>
> I wrote most parts of the documentation of the asyncio module, but I'm
> not sure that anyone already read it yet. Can you please at least take
> at look?
> http://docs.python.org/dev/library/asyncio.html
>
> Tell me if the documentation needs more examples. I don't want to add
> whole applications, only very short examples to explain one feature or
> concept, or show how to use one specific API.
>
> I just realized that add/remove_reader/writer() methods of the event
> loop were not documented, sock_recv/sendall/accept/connect() methods
> neither. I documented them.
>
> There are still many functions which only have "XXX" for documentation.
>
> If you would like to contribute, send patches on .rst files. The
> source of the documentation is in the Doc/library/ directory of
> CPython repository:
> http://hg.python.org/cpython/
>
> Files asyncio-*.rst:
> http://hg.python.org/cpython/file/default/Doc/library
>
> Victor
>
>
>
> --
> --Guido van Rossum (python.org/~guido <http://python.org/~guido>)
>
>
> _______________________________________________
> Python-Dev mailing list
> Python-Dev at python.org
> https://mail.python.org/mailman/listinfo/python-dev
> Unsubscribe: https://mail.python.org/mailman/options/python-dev/python%40mrabarnett.plus.com
>
>
>
> No virus found in this message.
> Checked by AVG - www.avg.com <http://www.avg.com>
> Version: 2014.0.4259 / Virus Database: 3697/7075 - Release Date: 02/08/14
>