summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2011-10-12 16:57:23 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2011-10-12 16:57:23 (GMT)
commitf55011f8b63d3b046c1ec580312bc52ca47d721b (patch)
tree67dc37443d86d918ac91681c083c1d83d3c3e09b /Doc/library
parent442ee03d35870216b45150512a0dc384409b39ff (diff)
downloadcpython-f55011f8b63d3b046c1ec580312bc52ca47d721b.zip
cpython-f55011f8b63d3b046c1ec580312bc52ca47d721b.tar.gz
cpython-f55011f8b63d3b046c1ec580312bc52ca47d721b.tar.bz2
Update doc for BlockingIOError and its alias in the io module
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/exceptions.rst9
-rw-r--r--Doc/library/io.rst12
2 files changed, 11 insertions, 10 deletions
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 67f2c63..ca8e4d8 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -396,6 +396,15 @@ depending on the system error code.
Corresponds to :c:data:`errno` ``EAGAIN``, ``EALREADY``,
``EWOULDBLOCK`` and ``EINPROGRESS``.
+ In addition to those of :exc:`OSError`, :exc:`BlockingIOError` can have
+ one more attribute:
+
+ .. attribute:: characters_written
+
+ An integer containing the number of characters written to the stream
+ before it blocked. This attribute is available when using the
+ buffered I/O classes from the :mod:`io` module.
+
.. exception:: ChildProcessError
Raised when an operation on a child process failed.
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 76c856e..86faa58 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -109,16 +109,8 @@ High-level Module Interface
.. exception:: BlockingIOError
- Error raised when blocking would occur on a non-blocking stream. It inherits
- :exc:`IOError`.
-
- In addition to those of :exc:`IOError`, :exc:`BlockingIOError` has one
- attribute:
-
- .. attribute:: characters_written
-
- An integer containing the number of characters written to the stream
- before it blocked.
+ This is a compatibility alias for the builtin :exc:`BlockingIOError`
+ exception.
.. exception:: UnsupportedOperation