Python Documentation (should be better?)

Steven Bethard steven.bethard at gmail.com
Wed May 11 15:33:32 EDT 2005


Christopher J. Bottaro wrote:
> After we were done, we talked about the pros and cons of the languages. 
> Funny, the con of Python (documentation) is PHP's strong point.  The PHP
> manual is extremely easy to navigate and its search feature works great. 
> Contrast that with Python, where you have to use "the tutorial" as the
> manual.  Also, the tutorial is just that...a tutorial, its a NOT a manual. 
> Its not organized like a manual and its not comprehensive like a manual,
> hell, raw_input() isn't even mentioned in Chapter 7. Input and Output.
> 
[snip]
> 
> What do yall think?

I have to say, I don't really have your troubles with the documentation, 
and I hardly ever use dir() in the interactive shell.  You mention only 
referring to the tutorial.  Why don't you check the Language 
Reference[1] or Library Reference[2]?

That said, if you see spots where the documentation needs help, the 
right answer is to file a feature request[3] to add documentation.  If 
you're feeling especially helpful, providing the documentation you'd 
like to be added would be greatly appreciated.  Python's a community 
effort -- if you see weak points, you can help the community build a 
better Python by taking the time to address them yourself.

STeVe

[1]http://docs.python.org/ref/ref.html
[2]http://docs.python.org/lib/lib.html
[3]http://sourceforge.net/tracker/?group_id=5470&atid=355470



More information about the Python-list mailing list