[docs] [issue9184] open() doc: default value for buffering is -1, not None

STINNER Victor report at bugs.python.org
Tue Jul 6 23:58:09 CEST 2010


New submission from STINNER Victor <victor.stinner at haypocalc.com>:

Examples:
 * open(filename) works
 * open(filename, buffering=-1) works
 * open(filename, buffering=None) fails

In the code:
 * _pyio.open(): default value is -1, type is int, no default value in the docstring
 * _io.open(): default value is not specified (C function), type is int, default value in the docstring is None

In the doc:
 * open() default value is None

The default value should be -1 everywhere. None is rejected by io.open (_io) and _pyio.open.

Attached patch fixes _io.open() docstring Python documentation.

----------
assignee: docs at python
components: Documentation, IO, Interpreter Core
files: open_doc_buffering.patch
keywords: patch
messages: 109434
nosy: docs at python, haypo, pitrou
priority: normal
severity: normal
status: open
title: open() doc: default value for buffering is -1, not None
versions: Python 3.1, Python 3.2, Python 3.3
Added file: http://bugs.python.org/file17886/open_doc_buffering.patch

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


More information about the docs mailing list