Python Documentation Standards

Steven Bethard steven.bethard at gmail.com
Thu Mar 16 16:08:32 CET 2006


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



More information about the Python-list mailing list