[docs] [issue11670] configparser read_file now iterates over f, docs still say it calls readline

Larry Hastings report at bugs.python.org
Fri Mar 25 11:08:19 CET 2011


New submission from Larry Hastings <larry at hastings.org>:

The documentation for configparser.RawConfigParser.read_file() states:

"Read and parse configuration data from the file or file-like object in f (only the readline() method is used)."

This was true in Python 3.1 and before.  However in 3.2 the implementation of read_file changed.  It no longer calls readline().  Instead, it iterates over the file object.  Whoever made this change neglected to

* fix the docs, or apparently
* tell anybody.

I've got the commit bit, so I'd be happy to fix this.

I'd like to add it to the What's New In Python 3.2 as well; there's a section about configparser changes that would be perfect.  Is it permissible to change the What's New document ex post facto like this?  (Adding rhettinger so he can answer this.)

----------
assignee: docs at python
components: Documentation
messages: 132075
nosy: docs at python, larry, rhettinger
priority: low
severity: normal
stage: needs patch
status: open
title: configparser read_file now iterates over f, docs still say it calls readline
type: behavior
versions: Python 3.2

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


More information about the docs mailing list