diff options
| author | Wellington Pardim <wellpardim10@gmail.com> | 2020-02-10 20:13:41 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-10 20:13:41 (GMT) |
| commit | 6c9974e12c50150149b989aaef68be1fe46ea670 (patch) | |
| tree | c9efc93c482c8f6a8f4205eb9378e726a3b53f89 | |
| parent | ed335cf53b5d4bca9a08c9b83ba684ba17be0f10 (diff) | |
| download | cpython-6c9974e12c50150149b989aaef68be1fe46ea670.zip cpython-6c9974e12c50150149b989aaef68be1fe46ea670.tar.gz cpython-6c9974e12c50150149b989aaef68be1fe46ea670.tar.bz2 | |
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>
| -rw-r--r-- | Doc/library/mmap.rst | 3 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2020-01-17-13-59-21.bpo-39369.Bx5yE3.rst | 1 |
2 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/mmap.rst b/Doc/library/mmap.rst index 12b14d6..1f3fbc3 100644 --- a/Doc/library/mmap.rst +++ b/Doc/library/mmap.rst @@ -244,7 +244,8 @@ To map anonymous memory, -1 should be passed as the fileno along with the length .. method:: readline() Returns a single line, starting at the current file position and up to the - next newline. + next newline. The file position is updated to point after the bytes that were + returned. .. method:: resize(newsize) diff --git a/Misc/NEWS.d/next/Documentation/2020-01-17-13-59-21.bpo-39369.Bx5yE3.rst b/Misc/NEWS.d/next/Documentation/2020-01-17-13-59-21.bpo-39369.Bx5yE3.rst new file mode 100644 index 0000000..7f41735 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2020-01-17-13-59-21.bpo-39369.Bx5yE3.rst @@ -0,0 +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.
\ No newline at end of file |