From 35115e6aabda3284bf6ac1c4278ddbff70c62ccf Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Fri, 28 Jun 2013 18:59:19 -0400 Subject: 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. --- Doc/library/fileinput.rst | 4 ++-- Lib/fileinput.py | 11 +++++------ Misc/ACKS | 1 + 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Doc/library/fileinput.rst b/Doc/library/fileinput.rst index 172a643..ce892ce 100644 --- a/Doc/library/fileinput.rst +++ b/Doc/library/fileinput.rst @@ -50,7 +50,7 @@ provided by this module. The following function is the primary interface of this module: -.. function:: input([files[, inplace[, backup[, mode[, openhook]]]]]) +.. function:: input([files[, inplace[, backup[, bufsize[, mode[, openhook]]]]]]) Create an instance of the :class:`FileInput` class. The instance will be used as global state for the functions of this module, and is also returned to use @@ -122,7 +122,7 @@ The class which implements the sequence behavior provided by the module is available for subclassing as well: -.. class:: FileInput([files[, inplace[, backup[, mode[, openhook]]]]]) +.. class:: FileInput([files[, inplace[, backup[,bufsize[, mode[, openhook]]]]]]) Class :class:`FileInput` is the implementation; its methods :meth:`filename`, :meth:`fileno`, :meth:`lineno`, :meth:`filelineno`, :meth:`isfirstline`, diff --git a/Lib/fileinput.py b/Lib/fileinput.py index ba48575..04e97bd 100644 --- a/Lib/fileinput.py +++ b/Lib/fileinput.py @@ -90,12 +90,11 @@ DEFAULT_BUFSIZE = 8*1024 def input(files=None, inplace=0, backup="", bufsize=0, mode="r", openhook=None): - """input([files[, inplace[, backup[, mode[, openhook]]]]]) + """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: @@ -182,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 fc0d9d2..f8e588e 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -937,6 +937,7 @@ John W. Shipman Joel Shprentz Itamar Shtull-Trauring Yue Shuaijie +Terrel Shumway Eric Siegerman Paul Sijben Tim Silk -- cgit v0.12