Terry J. Reedy added the comment:

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.

----------
title: bufsize parameter not documented in 2.7.5 -> Fix fileinput doc and 
docstrings (add 'buffer' in 2.7)
versions: +Python 3.3, Python 3.4

_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue18315>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: 
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

Reply via email to