[Python-checkins] cpython (3.2): Issue #13530: Document os.lseek() result

[victor.stinner]

http://hg.python.org/cpython/rev/46c418d8a480
changeset:   74018:46c418d8a480
branch:      3.2
parent:      74015:d7862e855274
user:        Victor Stinner <victor.stinner at haypocalc.com>
date:        Sat Dec 17 23:15:09 2011 +0100
summary:
  Issue #13530: Document os.lseek() result

Patch written by Jérémy Anger.

files:
  Doc/library/os.rst    |  2 +-
  Misc/ACKS             |  1 +
  Modules/posixmodule.c |  3 ++-
  3 files changed, 4 insertions(+), 2 deletions(-)


diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -706,7 +706,7 @@
    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
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -30,6 +30,7 @@
 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
--- a/Modules/posixmodule.c
+++ b/Modules/posixmodule.c
@@ -5687,7 +5687,8 @@
 
 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)

-- 
Repository URL: http://hg.python.org/cpython