Pythondocs.info : collaborative Python documentation project

2006-09-16 Thread nicolasfr
Hi,

I am a bit disapointed with the current Python online documentation. I
have read many messages of people complaining about the documentation,
it's lack of examples and the use of complicated sentences that you
need to read 10 times before understanding what it means.

That's why I have started a collaborative project to make a user
contributed Python documentation. The wiki is online here:
http://www.pythondocs.info

This is a fresh new website, so there's not much on it, but I hope to
make it grow quickly. Help and contributions are welcome; Please
register and start posting your own documentation on it.

Regards,

Nicolas.
-
http://www.pythondocs.info

-- 
http://mail.python.org/mailman/listinfo/python-list


Re: Pythondocs.info : collaborative Python documentation project

2006-09-16 Thread nicolasfr

Wildemar Wildenburger wrote:
> [EMAIL PROTECTED] wrote:
> > I have read many messages of people complaining about the documentation,
> > it's lack of examples and the use of complicated sentences that you
> > need to read 10 times before understanding what it means.
>  >
> Where have you read that?
>
> wildemar

I don't mean to start a flame war about this but here are some
reference of people, who like me, don't like the current python doc:
http://xahlee.org/UnixResource_dir/writ/python_doc.html
http://mail.python.org/pipermail/python-list/2005-May/280634.html
...
You really can find dozens of such discussions on the net.

I think the PHP documentation is a really good one in comparison.

Nicolas.

-- 
http://mail.python.org/mailman/listinfo/python-list


Re: Pythondocs.info : collaborative Python documentation project

2006-09-16 Thread nicolasfr

Rakotomandimby (R12y) wrote:
> What you should have done first is to suggest to contribute to the
> official Python doc.

I wrote an email a few months ago to the Python docs support email
address to offer my help but never got any answer.

> Then, if you encounter too much dumbs (and only in that case) you could
> fork docs.python.org and do your own project.
> That's the way free software works.

Everytime I am lookink at how to do this or that in Python I write it
down somewhere on my computer. (For ex. Threading. After reading the
official documentation I was a bit perplex. Hopefully I found an
article an managed to implement threads with only like 20 lines of code
in my script. That should have been in the docs first, not in an
article elsewhere... Same problem for handling gzipped files. I wanted
to know if the file I opened was a gzip archive or not. Not a clue in
the docs...) I have just decided to share all this knowledge this with
other. Community will decide if this wiki is of any interest. If not it
will just remain my personnal notebook for Python tips...

Anyway Python rocks, that's the important point!

-- 
http://mail.python.org/mailman/listinfo/python-list