diff options
| author | Erlend E. Aasland <erlend@python.org> | 2023-08-17 20:41:35 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-17 20:41:35 (GMT) |
| commit | 02079b010c39a89b284e8f0bb6d5f378e554260e (patch) | |
| tree | f38bf75ddbdedbe2ee9d0d5d5b82ca81e309ee38 | |
| parent | 5c76899dadf3bdcfdedf6f30b3ab9742cb87af04 (diff) | |
| download | cpython-02079b010c39a89b284e8f0bb6d5f378e554260e.zip cpython-02079b010c39a89b284e8f0bb6d5f378e554260e.tar.gz cpython-02079b010c39a89b284e8f0bb6d5f378e554260e.tar.bz2 | |
gh-107801: Improve the docs of the SEEK_* constants (#108099)
| -rw-r--r-- | Doc/library/os.rst | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst index 94b76e4..4668984 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, |