]> granicus.if.org Git - python/commitdiff
bpo-37014: Update docstring and Documentation of fileinput.FileInput(). (GH-13545)
authorMichele Angrisano <michele.angrisano@gmail.com>
Sun, 2 Jun 2019 21:01:49 +0000 (23:01 +0200)
committerEzio Melotti <ezio.melotti@gmail.com>
Sun, 2 Jun 2019 21:01:49 +0000 (23:01 +0200)
* bpo-37014: Update docstring and Documentation of fileinput.FileInput()

* Explain the behavior of fileinput.FileInput() when reading stdin.

* Update blurb.

* bpo-37014: Fix typo in the docstring and documentation.

Doc/library/fileinput.rst
Lib/fileinput.py
Misc/ACKS

index 14be492f55a67f15339793a0c106778dd888373a..f5e5280a136399853bfd451c8ec7baacee601ab0 100644 (file)
@@ -23,8 +23,9 @@ The typical use is::
 
 This iterates over the lines of all files listed in ``sys.argv[1:]``, defaulting
 to ``sys.stdin`` if the list is empty.  If a filename is ``'-'``, it is also
-replaced by ``sys.stdin``.  To specify an alternative list of filenames, pass it
-as the first argument to :func:`.input`.  A single file name is also allowed.
+replaced by ``sys.stdin`` and the optional arguments *mode* and *openhook*
+are ignored.  To specify an alternative list of filenames, pass it as the
+first argument to :func:`.input`.  A single file name is also allowed.
 
 All files are opened in text mode by default, but you can override this by
 specifying the *mode* parameter in the call to :func:`.input` or
index d868e74cd5e969fd44a10a6b5f2fd27358960443..c1b0ec9a8ed084f8b409bc7e81bab5dd53c0a294 100644 (file)
@@ -8,9 +8,9 @@ Typical use is:
 
 This iterates over the lines of all files listed in sys.argv[1:],
 defaulting to sys.stdin if the list is empty.  If a filename is '-' it
-is also replaced by sys.stdin.  To specify an alternative list of
-filenames, pass it as the argument to input().  A single file name is
-also allowed.
+is also replaced by sys.stdin and the optional arguments mode and
+openhook are ignored.  To specify an alternative list of filenames,
+pass it as the argument to input().  A single file name is also allowed.
 
 Functions filename(), lineno() return the filename and cumulative line
 number of the line that has just been read; filelineno() returns its
index 5c23df8c58992297563bbf0f99004c5143d6dc9f..082fa567f23aa6932670a7edb786a3357a4ee1c0 100644 (file)
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -55,6 +55,7 @@ Juancarlo Añez
 Chris Angelico
 Jérémy Anger
 Jon Anglin
+Michele Angrisano
 Ankur Ankan
 Heidi Annexstad
 Ramchandra Apte