summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/file.rst8
1 files changed, 6 insertions, 2 deletions
diff --git a/Doc/c-api/file.rst b/Doc/c-api/file.rst
index cc851e6..0cbe070 100644
--- a/Doc/c-api/file.rst
+++ b/Doc/c-api/file.rst
@@ -22,8 +22,9 @@ the :mod:`io` APIs instead.
Create a Python file object from the file descriptor of an already
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.
+ default. *name* is ignored and kept for backward compatibility. Return
+ *NULL* on failure. For a more comprehensive description of the arguments,
+ please refer to the :func:`io.open` function documentation.
.. warning::
@@ -31,6 +32,9 @@ the :mod:`io` APIs instead.
OS-level file descriptors can produce various issues (such as unexpected
ordering of data).
+ .. versionchanged:: 3.2
+ Ignore *name* attribute.
+
.. cfunction:: int PyObject_AsFileDescriptor(PyObject *p)