[Python-checkins] [3.12] gh-107801: Improve the docs of the SEEK_* constants (#108099) (#108108)
Yhg1s
webhook-mailer at python.org
Fri Aug 18 08:16:45 EDT 2023
https://github.com/python/cpython/commit/2b8e0207cb91c5377ea82638d038e737070c64bb
commit: 2b8e0207cb91c5377ea82638d038e737070c64bb
branch: 3.12
author: Erlend E. Aasland <erlend at python.org>
committer: Yhg1s <thomas at python.org>
date: 2023-08-18T14:16:42+02:00
summary:
[3.12] gh-107801: Improve the docs of the SEEK_* constants (#108099) (#108108)
(cherry picked from commit 02079b010c39a89b284e8f0bb6d5f378e554260e)
files:
M Doc/library/os.rst
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 94b76e4052b94..4668984b10c69 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1180,16 +1180,26 @@ as internal buffering of data.
SEEK_CUR
SEEK_END
- Parameters to the :func:`lseek` function. Their values are 0, 1, and 2,
- respectively.
+ Parameters to the :func:`lseek` function and the :meth:`~io.IOBase.seek`
+ method on :term:`file-like objects <file object>`,
+ for whence to adjust the file position indicator.
+
+ :const:`SEEK_SET`
+ Adjust the file position relative to the beginning of the file.
+ :const:`SEEK_CUR`
+ Adjust the file position relative to the current file position.
+ :const:`SEEK_END`
+ Adjust the file position relative to the end of the file.
+
+ Their values are 0, 1, and 2, respectively.
.. data:: SEEK_HOLE
SEEK_DATA
Parameters to the :func:`lseek` function and the :meth:`~io.IOBase.seek`
- method on file objects, for seeking file data and holes on sparsely
- allocated files.
+ method on :term:`file-like objects <file object>`,
+ for seeking file data and holes on sparsely allocated files.
:data:`!SEEK_DATA`
Adjust the file offset to the next location containing data,
More information about the Python-checkins
mailing list