From: Antoine Pitrou <solipsis@pitrou.net>
Date: Wed, 12 Oct 2011 16:57:23 +0000 (+0200)
Subject: Update doc for BlockingIOError and its alias in the io module
X-Git-Tag: v3.3.0a1~1198
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f55011f8b63d3b046c1ec580312bc52ca47d721b;p=thirdparty%2FPython%2Fcpython.git

Update doc for BlockingIOError and its alias in the io module
---

diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 67f2c63bdcd1..ca8e4d8b6d15 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 76c856edad65..86faa5827bb3 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