Skip to content

gh-107801: Improve the docs of the SEEK_* constants #108099

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erlend-aasland merged 3 commits into from
Aug 17, 2023
+14 −4
Merged

gh-107801: Improve the docs of the SEEK_* constants #108099

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
abce2cc
gh-107801: Improve the docs of the SEEK_* constants
erlend-aasland Aug 17, 2023
7fa4d3a
Also mention values
erlend-aasland Aug 17, 2023
a006a93
File-like objects
erlend-aasland Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
gh-107801: Improve the docs of the SEEK_* constants
  • Loading branch information
@erlend-aasland
erlend-aasland committed Aug 17, 2023
commit abce2cc45a479d342fd907a497bf9e77e79379c5
11 changes: 9 additions & 2 deletions Doc/library/os.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1180,8 +1180,15 @@ 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 file object, for whence to adjust the file position indicator.
Comment thread
AA-Turner marked this conversation as resolved.
Outdated

: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.


.. data:: SEEK_HOLE
Expand Down