[Tutor] Class Docs - how much is too much?
Tim Johnson
tim at johnsons-web.com
Wed Jan 26 22:46:08 CET 2011
* Emile van Sebille <emile at fenx.com> [110126 12:30]:
> On 1/26/2011 11:03 AM Tim Johnson said...
>>
>> I've developed a module which necessitates a very large amount of
>> documentation. At this point all of the documentation is in the
>> class docstring. I'm thinking that perhaps I should pare down the
>> docstring and deliver specific documentation topics with object
<<...>>
>> :) Perhaps there is a PEP for this and a link to such a PEP would
>> suffice.
>
> Yep -- google python pep docstring and you get
>
> http://www.python.org/dev/peps/pep-0257/
Thank you. That's all I need.
--
Tim
tim at johnsons-web.com or akwebsoft.com
http://www.akwebsoft.com
More information about the Tutor
mailing list