Python "header" files

Timo Virkkala a at a.invalid
Tue Jun 8 23:44:37 CEST 2004


beliavsky at aol.com wrote:
> Python "header" files could list only the 'def' statements and
> docstrings of Python functions and classes, but that does not tell you
> what the functions return. One could list the return statements as
> well, but there can be several of them in a function, and they often
> show HOW something is calculated, which is "too much information" for
> a header file.

Probably the most convenient way is to write good docstrings which document 
the return values as well, and then generate static documentation from them 
with pydoc.

http://www.python.org/doc/current/lib/module-pydoc.html

-- 
Timo "WT" Virkkala

   "In the battle between you and the world, bet on the world."



More information about the Python-list mailing list