]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Update doc for BlockingIOError and its alias in the io module
authorAntoine Pitrou <solipsis@pitrou.net>
Wed, 12 Oct 2011 16:57:23 +0000 (18:57 +0200)
committerAntoine Pitrou <solipsis@pitrou.net>
Wed, 12 Oct 2011 16:57:23 +0000 (18:57 +0200)
Doc/library/exceptions.rst
Doc/library/io.rst

index 67f2c63bdcd11438c88ec77ef0970e6e48907033..ca8e4d8b6d152a10bb203b5f5e08eb60becc3e56 100644 (file)
@@ -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.
index 76c856edad65982a6bf893e0066edef539f3fd00..86faa5827bb346e68d191cb8b0feb9c96095e182 100644 (file)
@@ -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