[Doc-SIG] Double specification of function signatures?

skip at pobox.com skip at pobox.com
Mon Apr 28 00:29:33 CEST 2008

    Michael> It seems that any documentation or help tool worth its salt
    Michael> should fetch the parameters from the definition and so
    Michael> including them in the docstring should be redundant
    Michael> duplication.

That's my position as well.  Currently we have no way to extract the
function signatures from C code on-the-fly or in a preprocessing step (might
be a good GSoC project), but for functions written in Python I'm of the
opinion the docstrings should not include function signatures.


More information about the Doc-SIG mailing list