Issue #25030: Merge seek() doc fixes from 3.4 into 3.5

This commit is contained in:
Martin Panter 2015-09-11 04:39:31 +00:00
commit 0e8e78e15d
2 changed files with 8 additions and 6 deletions

View File

@ -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
@ -783,10 +783,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

View File

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