mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-28 03:13:48 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

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

Browse source 
Patch from Shiyao Ma.
This commit is contained in:
Martin Panter 2015-09-11 03:58:30 +00:00
parent 91c03e090a
commit db4220ea09
3 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Doc/library/io.rst
View file

@ -301,11 +301,11 @@ I/O Base Classes
Note that it's already possible to iterate on file objects using ``for Note that it's already possible to iterate on file objects using ``for
line in file: ...`` without calling ``file.readlines()``. 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 Change the stream position to the given byte *offset*. *offset* is
interpreted relative to the position indicated by *whence*. Values for interpreted relative to the position indicated by *whence*. The default
*whence* are: value for *whence* is :data:`SEEK_SET`. Values for *whence* are:
* :data:`SEEK_SET` or ``0`` -- start of the stream (the default); * :data:`SEEK_SET` or ``0`` -- start of the stream (the default);
*offset* should be zero or positive *offset* should be zero or positive
@ -760,10 +760,11 @@ Text I/O
If *size* is specified, at most *size* characters will be read. 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 Change the stream position to the given *offset*. Behaviour depends on
on the *whence* parameter: the *whence* parameter. The default value for *whence* is
:data:`SEEK_SET`.
* :data:`SEEK_SET` or ``0``: seek from the start of the stream * :data:`SEEK_SET` or ``0``: seek from the start of the stream
(the default); *offset* must either be a number returned by (the default); *offset* must either be a number returned by

1
Misc/ACKS
View file

@ -1276,6 +1276,7 @@ Alexander Shigin
Pete Shinners Pete Shinners
Michael Shiplett Michael Shiplett
John W. Shipman John W. Shipman
Shiyao Ma
Alex Shkop Alex Shkop
Joel Shprentz Joel Shprentz
Yue Shuaijie Yue Shuaijie

2
Modules/_io/bytesio.c
View file

@ -530,7 +530,7 @@ bytesio_iternext(bytesio *self)
} }
PyDoc_STRVAR(seek_doc, PyDoc_STRVAR(seek_doc,
"seek(pos, whence=0) -> int. Change stream position.\n" "seek(pos[, whence]) -> int. Change stream position.\n"
"\n" "\n"
"Seek to byte offset pos relative to position indicated by whence:\n" "Seek to byte offset pos relative to position indicated by whence:\n"
" 0 Start of stream (the default). pos should be >= 0;\n" " 0 Start of stream (the default). pos should be >= 0;\n"