summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2013-06-28 18:59:28 -0400
committerTerry Jan Reedy <tjreedy@udel.edu>2013-06-28 18:59:28 -0400
commit70d2c711f10b385a4bc04b1b827883e12acc0509 (patch)
tree5b4c3590e1de8149eceb421f0e63fb0dd7f6d948
parent02e4a7b4a3a5fdab4cd45341cf915b3d39faf99d (diff)
downloadcpython-git-70d2c711f10b385a4bc04b1b827883e12acc0509.tar.gz
Issue #18315: Improve fileinput docs by adding 'bufsize' where missing and
replacing redundant signature in input() docstring with one-line summary. Original patch by Terrel Shumway.
-rw-r--r--Lib/fileinput.py12
-rw-r--r--Misc/ACKS1
2 files changed, 6 insertions, 7 deletions
diff --git a/Lib/fileinput.py b/Lib/fileinput.py
index dbbbb2192e..879a0fdaab 100644
--- a/Lib/fileinput.py
+++ b/Lib/fileinput.py
@@ -90,13 +90,11 @@ DEFAULT_BUFSIZE = 8*1024
def input(files=None, inplace=False, backup="", bufsize=0,
mode="r", openhook=None):
- """input(files=None, inplace=False, backup="", bufsize=0, \
-mode="r", openhook=None)
+ """Return an instance of the FileInput class, which can be iterated.
- Create an instance of the FileInput class. The instance will be used
- as global state for the functions of this module, and is also returned
- to use during iteration. The parameters to this function will be passed
- along to the constructor of the FileInput class.
+ The parameters are passed to the constructor of the FileInput class.
+ The returned instance, in addition to being an iterator,
+ keeps global state for the functions of this module,.
"""
global _state
if _state and _state._file:
@@ -183,7 +181,7 @@ def isstdin():
return _state.isstdin()
class FileInput:
- """class FileInput([files[, inplace[, backup[, mode[, openhook]]]]])
+ """FileInput([files[, inplace[, backup[, bufsize, [, mode[, openhook]]]]]])
Class FileInput is the implementation of the module; its methods
filename(), lineno(), fileline(), isfirstline(), isstdin(), fileno(),
diff --git a/Misc/ACKS b/Misc/ACKS
index f3e427a7dd..4e0fcbe256 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1125,6 +1125,7 @@ John W. Shipman
Joel Shprentz
Itamar Shtull-Trauring
Yue Shuaijie
+Terrel Shumway
Eric Siegerman
Paul Sijben
SilentGhost