mirror of
https://github.com/python/cpython.git
synced 2025-11-27 13:45:25 +00:00
Issue #25030: Merge seek() doc fixes from 3.5
This commit is contained in:
commit
b26cbf9636
2 changed files with 8 additions and 6 deletions
|
|
@ -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
|
||||||
|
|
@ -783,10 +783,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
|
||||||
|
|
|
||||||
|
|
@ -1312,6 +1312,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
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue