diff options
| author | Martin Panter <vadmium> | 2015-09-11 03:58:30 (GMT) |
|---|---|---|
| committer | Martin Panter <vadmium> | 2015-09-11 03:58:30 (GMT) |
| commit | db4220ea09c2a36b3eb7edbde40b356c9caad10d (patch) | |
| tree | 3bc2009c33dcf512b5dd4fc8a28cdb7d7335f4ac | |
| parent | 91c03e090a832680a57491ba44b96554eee01541 (diff) | |
| download | cpython-db4220ea09c2a36b3eb7edbde40b356c9caad10d.zip cpython-db4220ea09c2a36b3eb7edbde40b356c9caad10d.tar.gz cpython-db4220ea09c2a36b3eb7edbde40b356c9caad10d.tar.bz2 | |
Issue #25030: Do not document seek() as if it accepts keyword arguments
Patch from Shiyao Ma.
| -rw-r--r-- | Doc/library/io.rst | 13 | ||||
| -rw-r--r-- | Misc/ACKS | 1 | ||||
| -rw-r--r-- | Modules/_io/bytesio.c | 2 |
3 files changed, 9 insertions, 7 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 3adf6e9..9b12045 100644 --- 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 @@ -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 index 4652356..b55ab72 100644 --- 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" |