mirror of
https://github.com/python/cpython.git
synced 2025-08-03 00:23:06 +00:00
Issue #25030: Do not document seek() as if it accepts keyword arguments
Patch from Shiyao Ma.
This commit is contained in:
parent
91c03e090a
commit
db4220ea09
3 changed files with 9 additions and 7 deletions
|
@ -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
|
||||
|
|
|
@ -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"
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue