This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Author terry.reedy
Recipients Terrel.Shumway, docs@python, r.david.murray, terry.reedy
Date 2013-06-28.21:50:47
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <>
I just remembered: the first list of a .py file docstring should be a one line summary of what the callable does. It should not give the signature because (unlike C function currently) help does that for us from the callable itself (using the inspect module). Putting it in the docstring just repeats it. On 3.3.2:

>>> help(fileinput.input)
Help on function input in module fileinput:

input(files=None, inplace=False, backup='', bufsize=0, mode='r', openhook=None)
    input(files=None, inplace=False, backup="", bufsize=0, mode="r", openhook=None)
So the 3.x files need correcting also.
For .doc, the signature does need to be present and correct.
Date User Action Args
2013-06-28 21:50:48terry.reedysetrecipients: + terry.reedy, r.david.murray, docs@python, Terrel.Shumway
2013-06-28 21:50:47terry.reedysetmessageid: <>
2013-06-28 21:50:47terry.reedylinkissue18315 messages
2013-06-28 21:50:47terry.reedycreate