From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 17 Aug 2023 20:52:43 +0000 (-0700)
Subject: [3.11] gh-107801: Improve the docs of the SEEK_* constants (GH-108099) (#108100)
X-Git-Tag: v3.11.5~52
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d6555abfa7384b5a40435a11bdd2aa6bbf8f5cfc;p=thirdparty%2FPython%2Fcpython.git

[3.11] gh-107801: Improve the docs of the SEEK_* constants (GH-108099) (#108100)

(cherry picked from commit 02079b010c39a89b284e8f0bb6d5f378e554260e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 1d0d1049ebd7..993236c521a8 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1070,16 +1070,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,