Issue #21860: Correct docstrings of FileIO.seek() and FileIO.truncate() methods.

Patch by Terry Chia.
This commit is contained in:
Berker Peksag 2014-09-24 12:43:29 +03:00
parent 717b0d33a3
commit b87630c273
2 changed files with 6 additions and 3 deletions

View file

@ -237,6 +237,7 @@ Nicolas Chauvat
Jerry Chen
Michael Chermside
Ingrid Cheung
Terry Chia
Albert Chin-A-Young
Adal Chiriliuc
Matt Chisholm

View file

@ -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