mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-11-20 02:50:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)

Browse source 
Switch "list" with "iterable" to match with the implementation.
This commit is contained in:
Zackery Spytz 2018-09-29 10:15:55 -06:00 • committed by Brian Curtin
parent eef059657d
commit e45473e3ca
2 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/library/configparser.rst
View file

@ -963,16 +963,17 @@ ConfigParser Objects
.. method:: read(filenames, encoding=None)
Attempt to read and parse a list of filenames, returning a list of
Attempt to read and parse an iterable of filenames, returning a list of
filenames which were successfully parsed.
If *filenames* is a string, a :class:`bytes` object or a
:term:`path-like object`, it is treated as
a single filename. If a file named in *filenames* cannot be opened, that
file will be ignored. This is designed so that you can specify a list of
potential configuration file locations (for example, the current
directory, the user's home directory, and some system-wide directory),
and all existing configuration files in the list will be read.
file will be ignored. This is designed so that you can specify an
iterable of potential configuration file locations (for example, the
current directory, the user's home directory, and some system-wide
directory), and all existing configuration files in the iterable will be
read.
If none of the named files exist, the :class:`ConfigParser`
instance will contain an empty dataset. An application which requires