[Python-checkins] cpython (3.4): Issue #25030: Do not document seek() as if it accepts keyword arguments

Fri Sep 11 06:40:48 CEST 2015

https://hg.python.org/cpython/rev/0ca216f5276e
changeset: 97901:0ca216f5276e
branch: 3.4
parent: 97893:8ba735b018d2
user: Martin Panter <vadmium>
date: Fri Sep 11 03:58:30 2015 +0000
summary:
 Issue #25030: Do not document seek() as if it accepts keyword arguments
Patch from Shiyao Ma.
files:
 Doc/library/io.rst | 13 +++++++------
 Misc/ACKS | 1 +
 Modules/_io/bytesio.c | 2 +-
 3 files changed, 9 insertions(+), 7 deletions(-)

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -301,11 +301,11 @@
 Note that it's already possible to iterate on file objects using ``for
 line in file: ...`` without calling ``file.readlines()``.
 
- .. method:: seek(offset, whence=SEEK_SET)
+ .. method:: seek(offset[, whence])
 
 Change the stream position to the given byte *offset*. *offset* is
- interpreted relative to the position indicated by *whence*. Values for
- *whence* are:
+ interpreted relative to the position indicated by *whence*. The default
+ value for *whence* is :data:`SEEK_SET`. Values for *whence* are:
 
 * :data:`SEEK_SET` or ``0`` -- start of the stream (the default);
 *offset* should be zero or positive
@@ -760,10 +760,11 @@
 
 If *size* is specified, at most *size* characters will be read.
 
- .. method:: seek(offset, whence=SEEK_SET)
+ .. method:: seek(offset[, whence])
 
- Change the stream position to the given *offset*. Behaviour depends
- on the *whence* parameter:
+ Change the stream position to the given *offset*. Behaviour depends on
+ the *whence* parameter. The default value for *whence* is
+ :data:`SEEK_SET`.
 
 * :data:`SEEK_SET` or ``0``: seek from the start of the stream
 (the default); *offset* must either be a number returned by
diff --git a/Misc/ACKS b/Misc/ACKS
--- a/Misc/ACKS
+++ b/Misc/ACKS
@@ -1276,6 +1276,7 @@
 Pete Shinners
 Michael Shiplett
 John W. Shipman
+Shiyao Ma
 Alex Shkop
 Joel Shprentz
 Yue Shuaijie
diff --git a/Modules/_io/bytesio.c b/Modules/_io/bytesio.c
--- a/Modules/_io/bytesio.c
+++ b/Modules/_io/bytesio.c
@@ -530,7 +530,7 @@
 }
 
 PyDoc_STRVAR(seek_doc,
-"seek(pos, whence=0) -> int. Change stream position.\n"
+"seek(pos[, whence]) -> int. Change stream position.\n"
 "\n"
 "Seek to byte offset pos relative to position indicated by whence:\n"
 " 0 Start of stream (the default). pos should be >= 0;\n"
-- 
Repository URL: https://hg.python.org/cpython
