Skip to content

Commit

Permalink
[3.12] gh-107801: Improve the docs of the SEEK_* constants (#108099) (#…
Browse files Browse the repository at this point in the history
…108108)

(cherry picked from commit 02079b0)
  • Loading branch information
erlend-aasland committed Aug 18, 2023
1 parent 60edc70 commit 2b8e020
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions Doc/library/os.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 2b8e020

Please sign in to comment.