[Python-checkins] cpython (3.3): Issue #18315: Improve fileinput docs by adding 'bufsize' where missing and

terry.reedy python-checkins at python.org
Sat Jun 29 01:00:21 CEST 2013


http://hg.python.org/cpython/rev/0760b58526ba
changeset:   84362:0760b58526ba
branch:      3.3
parent:      84358:7c807bc15fa8
user:        Terry Jan Reedy <tjreedy at udel.edu>
date:        Fri Jun 28 18:59:28 2013 -0400
summary:
  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.

files:
  Lib/fileinput.py |  12 +++++-------
  Misc/ACKS        |   1 +
  2 files changed, 6 insertions(+), 7 deletions(-)


diff --git a/Lib/fileinput.py b/Lib/fileinput.py
--- a/Lib/fileinput.py
+++ b/Lib/fileinput.py
@@ -90,13 +90,11 @@
 
 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 @@
     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
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1125,6 +1125,7 @@
 Joel Shprentz
 Itamar Shtull-Trauring
 Yue Shuaijie
+Terrel Shumway
 Eric Siegerman
 Paul Sijben
 SilentGhost

-- 
Repository URL: http://hg.python.org/cpython


More information about the Python-checkins mailing list