diff options
| author | Erlend E. Aasland <erlend@python.org> | 2023-08-29 20:19:08 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-29 20:19:08 (GMT) |
| commit | 036dd6958a14014947904914065119123430df95 (patch) | |
| tree | 9d3a882a9cc5c7cba3b6f033048ec2811976db8b /Modules/_io/clinic/iobase.c.h | |
| parent | 4afc5d87161c7f079600380b3ef4579d9102ba97 (diff) | |
| download | cpython-036dd6958a14014947904914065119123430df95.zip cpython-036dd6958a14014947904914065119123430df95.tar.gz cpython-036dd6958a14014947904914065119123430df95.tar.bz2 | |
[3.12] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268) (#108655)
(cherry picked from commit 8178a88bd81edae87d6974483e4de9b32e808797)
- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Diffstat (limited to 'Modules/_io/clinic/iobase.c.h')
| -rw-r--r-- | Modules/_io/clinic/iobase.c.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/Modules/_io/clinic/iobase.c.h b/Modules/_io/clinic/iobase.c.h index 773e001..e29a4f1 100644 --- a/Modules/_io/clinic/iobase.c.h +++ b/Modules/_io/clinic/iobase.c.h @@ -14,6 +14,11 @@ PyDoc_STRVAR(_io__IOBase_seek__doc__, "\n" "Change the stream position to the given byte offset.\n" "\n" +" offset\n" +" The stream position, relative to \'whence\'.\n" +" whence\n" +" The relative position to seek from.\n" +"\n" "The offset is interpreted relative to the position indicated by whence.\n" "Values for whence are:\n" "\n" @@ -436,4 +441,4 @@ _io__RawIOBase_readall(PyObject *self, PyObject *Py_UNUSED(ignored)) { return _io__RawIOBase_readall_impl(self); } -/*[clinic end generated code: output=301b22f8f75ce3dc input=a9049054013a1b77]*/ +/*[clinic end generated code: output=7c2df7a330be8b5b input=a9049054013a1b77]*/ |