summaryrefslogtreecommitdiffstats
path: root/Doc/library/os.rst
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2014-01-19 03:57:05 (GMT)
committerBenjamin Peterson <benjamin@python.org>2014-01-19 03:57:05 (GMT)
commitdc3cce077d31b613bee8bc07d9c97bf63a2304f3 (patch)
tree5a4e1a1d100b1559625c1f34ffcf79682fcee77b /Doc/library/os.rst
parentbd22d39bae7f52f291ab9a374185ef4f8e5ff174 (diff)
parente83ed4328121747fc9b201497e3ebdaa43f90537 (diff)
downloadcpython-dc3cce077d31b613bee8bc07d9c97bf63a2304f3.zip
cpython-dc3cce077d31b613bee8bc07d9c97bf63a2304f3.tar.gz
cpython-dc3cce077d31b613bee8bc07d9c97bf63a2304f3.tar.bz2
merge 3.3 (#17811)
Diffstat (limited to 'Doc/library/os.rst')
-rw-r--r--Doc/library/os.rst16
1 files changed, 10 insertions, 6 deletions
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
index 32c1563..1fc8de9 100644
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1103,9 +1103,12 @@ or `the MSDN <http://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Window
.. function:: readv(fd, buffers)
- Read from a file descriptor into a number of writable buffers. *buffers* is
- an arbitrary sequence of writable buffers. Returns the total number of bytes
- read.
+ Read from a file descriptor *fd* into a number of mutable :term:`bytes-like
+ objects <bytes-like object>` *buffers*. :func:`~os.readv` will transfer data
+ into each buffer until it is full and then move on to the next buffer in the
+ sequence to hold the rest of the data. :func:`~os.readv` returns the total
+ number of bytes read (which may be less than the total capacity of all the
+ objects).
Availability: Unix.
@@ -1155,9 +1158,10 @@ or `the MSDN <http://msdn.microsoft.com/en-us/library/z0kc8e3z.aspx>`_ on Window
.. function:: writev(fd, buffers)
- Write the contents of *buffers* to file descriptor *fd*, where *buffers*
- is an arbitrary sequence of buffers.
- Returns the total number of bytes written.
+ Write the contents of *buffers* to file descriptor *fd*. *buffers* must be a
+ sequence of :term:`bytes-like objects <bytes-like object>`.
+ :func:`~os.writev` writes the contents of each object to the file descriptor
+ and returns the total number of bytes written.
Availability: Unix.