summaryrefslogtreecommitdiffstats
path: root/Modules/_io
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2014-09-24 09:43:29 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2014-09-24 09:43:29 (GMT)
commitb87630c273ab3ff68d4dbee61fe7ec9c65eeccb8 (patch)
tree86c0bb680b4bc2cd02e66c233c32e24745081208 /Modules/_io
parent717b0d33a331430b6f0af890ec183567ed95b7fc (diff)
downloadcpython-b87630c273ab3ff68d4dbee61fe7ec9c65eeccb8.zip
cpython-b87630c273ab3ff68d4dbee61fe7ec9c65eeccb8.tar.gz
cpython-b87630c273ab3ff68d4dbee61fe7ec9c65eeccb8.tar.bz2
Issue #21860: Correct docstrings of FileIO.seek() and FileIO.truncate() methods.
Patch by Terry Chia.
Diffstat (limited to 'Modules/_io')
-rw-r--r--Modules/_io/fileio.c8
1 files changed, 5 insertions, 3 deletions
diff --git a/Modules/_io/fileio.c b/Modules/_io/fileio.c
index 81e2906..a2b253b 100644
--- a/Modules/_io/fileio.c
+++ b/Modules/_io/fileio.c
@@ -1124,7 +1124,8 @@ PyDoc_STRVAR(fileno_doc,
"This is needed for lower-level file interfaces, such the fcntl module.");
PyDoc_STRVAR(seek_doc,
-"seek(offset: int[, whence: int]) -> None. Move to new file position.\n"
+"seek(offset: int[, whence: int]) -> int. Move to new file position and\n"
+"return the file position.\n"
"\n"
"Argument offset is a byte count. Optional argument whence defaults to\n"
"0 (offset from start of file, offset should be >= 0); other values are 1\n"
@@ -1136,9 +1137,10 @@ PyDoc_STRVAR(seek_doc,
#ifdef HAVE_FTRUNCATE
PyDoc_STRVAR(truncate_doc,
-"truncate([size: int]) -> None. Truncate the file to at most size bytes.\n"
+"truncate([size: int]) -> int. Truncate the file to at most size bytes\n"
+"and return the truncated size.\n"
"\n"
-"Size defaults to the current file position, as returned by tell()."
+"Size defaults to the current file position, as returned by tell().\n"
"The current file position is changed to the value of size.");
#endif