Re: [Doc-SIG] Double specification of function signatures?

[email protected] Sun, 27 Apr 2008 17:29:33 -0500

Newsgroups	gmane.comp.python.devel,gmane.comp.python.documentation
Message-ID	<[email protected]>

    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.

Skip
_______________________________________________
Python-Dev mailing list
[email protected]
http://mail.python.org/mailman/listinfo/python-dev
Unsubscribe: http://mail.python.org/mailman/options/python-dev/python-python-dev%40m.gmane.org