Python Documentation Standards

Colin J. Williams cjw at sympatico.ca
Fri Mar 17 23:45:11 CET 2006


Steven Bethard wrote:
> Colin J. Williams wrote:
> 
>> Doc strings provide us with a great opportunity to illuminate our code.
>>
>> In the example below, __init__ refers us to the class's documentation,
>> but the class doc doesn't help much.
> 
> 
> It doesn't?
> 
>  >>> print list.__doc__
> list() -> new list
> list(sequence) -> new list initialized from sequence's items
> 
> What is it you were hoping to see in constructor documentation?
> 
> STeVe
You are right, I didn't dig far enough.

Colin W.



More information about the Python-list mailing list