[Python-Dev] Python Doc problems

Steve Holden steve at holdenweb.com
Sat Sep 30 09:41:38 CEST 2006


Guido van Rossum wrote:
> On 9/29/06, A.M. Kuchling <amk at amk.ca> wrote:
> 
>>On Fri, Sep 29, 2006 at 09:49:35AM +0900, stephen at xemacs.org wrote:
>>
>>>What is lost according to him is information about how the elements of
>>>a module work together.  The docstrings tend to be narrowly focused on
>>>the particular function or variable, and too often discuss
>>>implementation details.
>>
>>I agree with this, and am not very interested in tools such as epydoc
>>for this reason.  In such autogenerated documentation, you wind up
>>with a list of every single class and function, and both trivial and
>>important classes are given exactly the same emphasis.  Such docs are
>>useful as a reference when you know what class you need to look at,
>>but then pydoc also works well for that purpose.
> 
> 
> Right.
> 
> BTW isn't xah a well-known troll? (There are exactly 666 Google hits
> for the query ``xah troll'' -- draw your own conclusions. :-)
> 
The calming influence of c.l.py appears to have worked its magic on xah 
to the extent that his most recent post didn't contain any expletives. 
Maybe there's hope for him yet.

668-and-counting-ly y'rs  - steve
-- 
Steve Holden       +44 150 684 7255  +1 800 494 3119
Holden Web LLC/Ltd          http://www.holdenweb.com
Skype: holdenweb       http://holdenweb.blogspot.com
Recent Ramblings     http://del.icio.us/steve.holden



More information about the Python-Dev mailing list