[Doc-SIG] What docs should be in the source file?
Thu, 22 Mar 2001 11:54:09 +0100
Just to drop in an opinion on the subject:
I think almost all API related documentation should go into the
source file. Concepts, graphics and other things can be kept
in different files, e.g. Word files, but the API should be completely
defined in the source file.
This is what I was targetting with PEP 224 (attribute docstrings),
but which will not happen... maybe Ping has an alternative which
will let me document attributes too ?!
Company & Consulting: http://www.egenix.com/
Python Pages: http://www.lemburg.com/python/