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.
This commit is contained in:
parent
02e4a7b4a3
commit
70d2c711f1
|
@ -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(),
|
||||
|
|
Loading…
Reference in New Issue