summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2012-06-24 11:24:56 (GMT)
committerGeorg Brandl <georg@python.org>2012-06-24 11:24:56 (GMT)
commitb2462e2b8c643ff040a46f992b78b16013222c09 (patch)
treeb0fd729fdf5b9e36eea6f16d8afeff7cb259d3d6 /Doc/library
parentb8f2d29ea9db281d34502d7299bee9e680e076ff (diff)
downloadcpython-b2462e2b8c643ff040a46f992b78b16013222c09.zip
cpython-b2462e2b8c643ff040a46f992b78b16013222c09.tar.gz
cpython-b2462e2b8c643ff040a46f992b78b16013222c09.tar.bz2
Minor clarification about fdopen().
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/os.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 0729a94..574ee1d 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -600,15 +600,16 @@ process and user.
File Object Creation
--------------------
-These functions create new :term:`file objects <file object>`. (See also :func:`open`.)
+These functions create new :term:`file objects <file object>`. (See also
+:func:`~os.open` for opening file descriptors.)
.. function:: fdopen(fd, *args, **kwargs)
- Return an open file object connected to the file descriptor *fd*.
- This is an alias of :func:`open` and accepts the same arguments.
- The only difference is that the first argument of :func:`fdopen`
- must always be an integer.
+ Return an open file object connected to the file descriptor *fd*. This is an
+ alias of the :func:`open` built-in function and accepts the same arguments.
+ The only difference is that the first argument of :func:`fdopen` must always
+ be an integer.
.. _os-fd-ops:
@@ -952,10 +953,10 @@ as internal buffering of data.
.. note::
This function is intended for low-level I/O and must be applied to a file
- descriptor as returned by :func:`os.open` or :func:`pipe`. To read a "file object"
- returned by the built-in function :func:`open` or by :func:`popen` or
- :func:`fdopen`, or :data:`sys.stdin`, use its :meth:`~file.read` or
- :meth:`~file.readline` methods.
+ descriptor as returned by :func:`os.open` or :func:`pipe`. To read a
+ "file object" returned by the built-in function :func:`open` or by
+ :func:`popen` or :func:`fdopen`, or :data:`sys.stdin`, use its
+ :meth:`~file.read` or :meth:`~file.readline` methods.
.. function:: sendfile(out, in, offset, nbytes)