From: Victor Stinner <victor.stinner@haypocalc.com>
Date: Sat, 17 Dec 2011 22:15:09 +0000 (+0100)
Subject: Issue #13530: Document os.lseek() result
X-Git-Tag: v3.2.3rc1~277
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=e83f899364607d9c6ca8413f0db6bca6bd39953a;p=thirdparty%2FPython%2Fcpython.git

Issue #13530: Document os.lseek() result

Patch written by Jérémy Anger.
---

diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 767c40f39aad..df9a6b6602b1 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -706,7 +706,7 @@ as internal buffering of data.
    by *how*: :const:`SEEK_SET` or ``0`` to set the position relative to the
    beginning of the file; :const:`SEEK_CUR` or ``1`` to set it relative to the
    current position; :const:`os.SEEK_END` or ``2`` to set it relative to the end of
-   the file.
+   the file. Return the new cursor position in bytes, starting from the beginning.
 
    Availability: Unix, Windows.
 
diff --git a/Misc/ACKS b/Misc/ACKS
index 0f921658d667..24923da367bb 100644
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -30,6 +30,7 @@ John Anderson
 Erik Andersén
 Oliver Andrich
 Ross Andrus
+Jérémy Anger
 Jon Anglin
 Éric Araujo
 Alicia Arlen
diff --git a/Modules/posixmodule.c b/Modules/posixmodule.c
index 66cd153be3e5..673877a7b067 100644
--- a/Modules/posixmodule.c
+++ b/Modules/posixmodule.c
@@ -5687,7 +5687,8 @@ posix_dup2(PyObject *self, PyObject *args)
 
 PyDoc_STRVAR(posix_lseek__doc__,
 "lseek(fd, pos, how) -> newpos\n\n\
-Set the current position of a file descriptor.");
+Set the current position of a file descriptor.\n\
+Return the new cursor position in bytes, starting from the beginning.");
 
 static PyObject *
 posix_lseek(PyObject *self, PyObject *args)