diff options
| author | Antoine Pitrou <solipsis@pitrou.net> | 2010-06-15 17:00:21 (GMT) |
|---|---|---|
| committer | Antoine Pitrou <solipsis@pitrou.net> | 2010-06-15 17:00:21 (GMT) |
| commit | 5d8a6c85eca9e64d63fb508f16b4de9a0600d14c (patch) | |
| tree | 8f08994b38fe409f156df28448e1953ad00b8d47 /Doc/c-api | |
| parent | e41a19e71ad5ffa2968916f1d81e3323a4f71542 (diff) | |
| download | cpython-5d8a6c85eca9e64d63fb508f16b4de9a0600d14c.zip cpython-5d8a6c85eca9e64d63fb508f16b4de9a0600d14c.tar.gz cpython-5d8a6c85eca9e64d63fb508f16b4de9a0600d14c.tar.bz2 | |
Fixes to the PyFile_FromFd() doc, by Renato Cunha.
Diffstat (limited to 'Doc/c-api')
| -rw-r--r-- | Doc/c-api/file.rst | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Doc/c-api/file.rst b/Doc/c-api/file.rst index 599717b..23ec5e9 100644 --- a/Doc/c-api/file.rst +++ b/Doc/c-api/file.rst @@ -13,12 +13,13 @@ change in future releases of Python. The ``PyFile_`` APIs are a wrapper over the :mod:`io` module. -.. cfunction:: PyFile_FromFd(int fd, char *name, char *mode, int buffering, char *encoding, char *newline, int closefd) +.. cfunction:: PyFile_FromFd(int fd, char *name, char *mode, int buffering, char *encoding, char *errors, char *newline, int closefd) Create a new :ctype:`PyFileObject` from the file descriptor of an already - opened file *fd*. The arguments *name*, *encoding* and *newline* can be - *NULL* to use the defaults; *buffering* can be *-1* to use the default. - Return *NULL* on failure. + opened file *fd*. The arguments *name*, *encoding*, *errors* and *newline* + can be *NULL* to use the defaults; *buffering* can be *-1* to use the + default. Return *NULL* on failure. For a more comprehensive description of + the arguments, please refer to the :func:`io.open` function documentation. .. warning:: |