[New-bugs-announce] [issue7417] open builtin has no signature in docstring

ulrik report at bugs.python.org
Tue Dec 1 14:41:42 CET 2009


New submission from ulrik <ulrik.sverdrup at gmail.com>:

Python 3.1.1's open has no signature in the docstring so the
documentation for this builtin function is unfortunately very confusing
(IMO is missing the most important part).

>>> help(open)

open(...)
    Open file and return a stream.  Raise IOError upon failure.
    
    ...

----

This must be a regression from the C port of the io module.

I'm keeping my eyes open for more issues like this. Python must be more
friendly to newcomers, but I have seen tendencies of confusing
documentation in Python 3.

----------
components: Library (Lib)
messages: 95856
nosy: englabenny
severity: normal
status: open
title: open builtin has no signature in docstring
versions: Python 3.1

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue7417>
_______________________________________


More information about the New-bugs-announce mailing list