Skip to content

Commit 6c9974e

Browse files
bpo-39369 Doc: Update mmap readline method documentation (GH-17957)
* Update mmap readline method documentation Update mmap `readline` method description. The fact that the `readline` method does update the file position should not be ignored since this might give the impression for the programmer that it doesn't update it. * 📜🤖 Added by blurb_it. Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
1 parent ed335cf commit 6c9974e

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

Doc/library/mmap.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,8 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
244244
.. method:: readline()
245245

246246
Returns a single line, starting at the current file position and up to the
247-
next newline.
247+
next newline. The file position is updated to point after the bytes that were
248+
returned.
248249

249250

250251
.. method:: resize(newsize)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update mmap readline method description. The fact that the readline method does update the file position should not be ignored since this might give the impression for the programmer that it doesn't update it.

0 commit comments

Comments
 (0)