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

[Brian Curtin]

On Sat, Feb 8, 2014 at 6:00 PM, MRAB  wrote:
> 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

Fixed: http://hg.python.org/cpython/rev/3cfaeb788e00 - thanks!
___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

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

[Victor Stinner]

2014-02-09 1:00 GMT+01:00 MRAB :
> Some spelling mistakes:

Please, try to write a patch or it will be hard to merge fixes.

Victor
___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

Re: [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* mailto:victor.stin...@gmail.com>>
Date: Sat, Feb 8, 2014 at 2:38 PM
Subject: [python-tulip] Need help to finish asyncio documentation
To: python-tulip mailto:python-tu...@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 )


___
Python-Dev mailing list
Python-Dev@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 
Version: 2014.0.4259 / Virus Database: 3697/7075 - Release Date: 02/08/14



___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

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

[Guido van Rossum]

On Sat, Feb 8, 2014 at 3:47 PM, Antoine Pitrou  wrote:

> On Sat, 8 Feb 2014 15:32:23 -0800
> Guido van Rossum  wrote:
> > We could really use more help reviewing and finishing asyncio's docs!
>
> Well, it's probably difficult for people to help when they are not
> acquainted with the details of asyncio's functioning :-)
>

Very funny. :-)

But seriously: as a potential reviewer, you can try to write a simple
asyncio app from scratch using the docs available, and report (preferably
on the python-tulip list) any issues you encountered, whether they be
English spelling or grammar (if those are your thing), confusing on
incorrect documentation, missing or buggy examples, and so on. Plenty of
people so far have contributed *code*, even without documentation (apart
from PEP 3156), and it should be just as easy to contribute *docs*.

-- 
--Guido van Rossum (python.org/~guido)
___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

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

[Antoine Pitrou]

On Sat, 8 Feb 2014 15:32:23 -0800
Guido van Rossum  wrote:
> We could really use more help reviewing and finishing asyncio's docs!

Well, it's probably difficult for people to help when they are not
acquainted with the details of asyncio's functioning :-)

Regards

Antoine.


___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

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

[Guido van Rossum]

We could really use more help reviewing and finishing asyncio's docs!

-- Forwarded message --
From: Victor Stinner 
Date: Sat, Feb 8, 2014 at 2:38 PM
Subject: [python-tulip] Need help to finish asyncio documentation
To: python-tulip 


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)
___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com

Re: [Python-Dev] Summary of Python tracker Issues

[francis]

On 02/07/2014 06:07 PM, Python tracker wrote:

Open issues with patches: 2045


Has somebody done a graphic of that data againsttime?

Regards,
francis

___
Python-Dev mailing list
Python-Dev@python.org
https://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: 
https://mail.python.org/mailman/options/python-dev/archive%40mail-archive.com