summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorZackery Spytz <zspytz@gmail.com>2018-09-29 16:15:55 (GMT)
committerBrian Curtin <brian@python.org>2018-09-29 16:15:55 (GMT)
commite45473e3ca31e5b78dc85cab575f5bb60d5b7f8f (patch)
tree356cfeb6de1032846ea00e229f861de7ee8fb34e /Doc/library
parenteef059657d6b10babdb4831e1148d60cc644ee9a (diff)
downloadcpython-e45473e3ca31e5b78dc85cab575f5bb60d5b7f8f.zip
cpython-e45473e3ca31e5b78dc85cab575f5bb60d5b7f8f.tar.gz
cpython-e45473e3ca31e5b78dc85cab575f5bb60d5b7f8f.tar.bz2
bpo-27351: Fix ConfigParser.read() documentation and docstring (GH-8123)
Switch "list" with "iterable" to match with the implementation.
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/configparser.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/configparser.rst b/Doc/library/configparser.rst
index 1e5f25f..0ae466e 100644
--- a/Doc/library/configparser.rst
+++ b/Doc/library/configparser.rst
@@ -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