summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorandrei kulakov <andrei.avk@gmail.com>2021-07-13 14:07:56 (GMT)
committerGitHub <noreply@github.com>2021-07-13 14:07:56 (GMT)
commit3b5b99da4b256a31933112f4a2385386149c19e1 (patch)
treef58f49e08398128b980bde26f4a5c4a2bccffeaa /Doc/library
parent48a5aa7f128caf5a46e4326c1fd285cd5fc8e59d (diff)
downloadcpython-3b5b99da4b256a31933112f4a2385386149c19e1.zip
cpython-3b5b99da4b256a31933112f4a2385386149c19e1.tar.gz
cpython-3b5b99da4b256a31933112f4a2385386149c19e1.tar.bz2
bpo-43126: Expand docs on io.IOBase.readlines() method (#27061)
Co-authored-by: Ɓukasz Langa <lukasz@langa.pl>
Diffstat (limited to 'Doc/library')
-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()``.