Q re documentation Python style

bearophileHUGS at lycos.com bearophileHUGS at lycos.com
Mon Jun 9 16:04:31 CEST 2008


kj:
> I have some functions
> that require a very long docstring to document, and somehow I find
> it a bit disconcerting to stick a few screenfuls of text between
> the top line of a function definition and its body.

You may put the main function(s) documentation in the docstring of the
module, and a much shorter version in the docstring of the function.

Bye,
bearophile



More information about the Python-list mailing list