Re: Python Documentation Standards

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

Re: Python Documentation Standards

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() ->

Re: Python Documentation Standards

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 i

Python Documentation Standards

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. Are there any guideline which cover such things? PEP 8 has general advice