[Tutor] Class Docs - how much is too much?
Tim Johnson
tim at johnsons-web.com
Wed Jan 26 20:03:24 CET 2011
FYI: I'm currently using version 2.6.5
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
methods. Example:
## Instantiation examples
o.intialize()
## configuration code to copy and paste into file
o.configuration()
## Internal processes
o.internals()
## ... etc.
## Docstring would include instructions for implementing such
## methods.
:) Perhaps there is a PEP for this and a link to such a PEP would
suffice.
thanks
--
Tim
tim at johnsons-web.com or akwebsoft.com
http://www.akwebsoft.com
More information about the Tutor
mailing list