From: Terry Jan Reedy Date: Fri, 28 Jun 2013 22:59:28 +0000 (-0400) Subject: Issue #18315: Improve fileinput docs by adding 'bufsize' where missing and X-Git-Tag: v3.4.0a1~372^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=70d2c711f10b385a4bc04b1b827883e12acc0509;p=thirdparty%2FPython%2Fcpython.git 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. --- diff --git a/Lib/fileinput.py b/Lib/fileinput.py index dbbbb2192ea6..879a0fdaab62 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 f3e427a7dd1a..4e0fcbe2565e 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