[Python-checkins] Document default parameter of .seek() in the signature. (GH-14691)

Miss Islington (bot) webhook-mailer at python.org
Wed Jul 10 22:50:03 EDT 2019


https://github.com/python/cpython/commit/0517375c4494b728171b0e306959e3f2703e0046
commit: 0517375c4494b728171b0e306959e3f2703e0046
branch: 2.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2019-07-10T19:49:59-07:00
summary:

Document default parameter of .seek() in the signature. (GH-14691)

(cherry picked from commit 2a3d4d9c53dd4831c3ecf56bc7c4a289c33030d6)

Co-authored-by: Benjamin Peterson <benjamin at python.org>

files:
M Doc/library/io.rst

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index dcdd01cd0aa5..7c053f973aa1 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -304,7 +304,7 @@ 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])
+   .. method:: seek(offset, whence=SEEK_SET)
 
       Change the stream position to the given byte *offset*.  *offset* is
       interpreted relative to the position indicated by *whence*.  The default
@@ -736,7 +736,7 @@ Text I/O
 
       If *limit* is specified, at most *limit* characters will be read.
 
-   .. method:: seek(offset[, whence])
+   .. method:: seek(offset, whence=SEEK_SET)
 
       Change the stream position to the given *offset*.  Behaviour depends on
       the *whence* parameter.  The default value for *whence* is



More information about the Python-checkins mailing list