summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2021-07-13 14:41:12 (GMT)
committerGitHub <noreply@github.com>2021-07-13 14:41:12 (GMT)
commit9b369c952cbefb064dda6cb781e66cc1b793fffa (patch)
tree7cb7b899e883dcf929a43245675fa87367a1af13
parent1cc6769e4146951d47528a97e56ba1e8e9ee7fc1 (diff)
downloadcpython-9b369c952cbefb064dda6cb781e66cc1b793fffa.zip
cpython-9b369c952cbefb064dda6cb781e66cc1b793fffa.tar.gz
cpython-9b369c952cbefb064dda6cb781e66cc1b793fffa.tar.bz2
bpo-43126: Expand docs on io.IOBase.readlines() method (GH-27061) (GH-27113)
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl> (cherry picked from commit 3b5b99da4b256a31933112f4a2385386149c19e1) Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
-rw-r--r--Doc/library/io.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index f9ffc19..0881015 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -391,6 +391,9 @@ I/O Base Classes
to control the number of lines read: no more lines will be read if the
total size (in bytes/characters) of all lines so far exceeds *hint*.
+ *hint* values of ``0`` or less, as well as ``None``, are treated as no
+ hint.
+
Note that it's already possible to iterate on file objects using ``for
line in file: ...`` without calling ``file.readlines()``.