Issue #25030: Do not document seek() as if it accepts keyword arguments

Martin Panter · Martin Panter · commit db4220ea09c2 · 2015-09-11T03:58:30.000Z
Patch from Shiyao Ma.
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
@@ -301,11 +301,11 @@ I/O Base Classes
       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 @@ Text I/O
 
       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
@@ -1276,6 +1276,7 @@ Alexander Shigin
 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
@@ -530,7 +530,7 @@ bytesio_iternext(bytesio *self)
 }
 
 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"

Original file line number	Diff line number	Diff line change
`@@ -530,7 +530,7 @@ bytesio_iternext(bytesio *self)`
`530`	`530`	`}`
`531`	`531`
`532`	`532`	`PyDoc_STRVAR(seek_doc,`
`533`		`-"seek(pos, whence=0) -> int. Change stream position.\n"`
	`533`	`+"seek(pos[, whence]) -> int. Change stream position.\n"`
`534`	`534`	`"\n"`
`535`	`535`	`"Seek to byte offset pos relative to position indicated by whence:\n"`
`536`	`536`	`" 0 Start of stream (the default). pos should be >= 0;\n"`