From: Benjamin Peterson <benjamin@python.org>
Date: Sun, 28 Jun 2009 17:32:20 +0000 (+0000)
Subject: document BufferedIOBase.raw and TextIOBase.buffer
X-Git-Tag: v3.2a1~2968
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c609b6b04bae561b2178d82e5e7011c55e17b05f;p=python

document BufferedIOBase.raw and TextIOBase.buffer
---

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 58661133aa..71d3f67403 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -359,9 +359,15 @@ I/O Base Classes
    implementation, but wrap one like :class:`BufferedWriter` and
    :class:`BufferedReader`.
 
-   :class:`BufferedIOBase` provides or overrides these methods in addition to
+   :class:`BufferedIOBase` provides or overrides these members in addition to
    those from :class:`IOBase`:
 
+   .. attribute:: raw
+
+      The underlying raw stream (a :class:`RawIOBase` instance) that
+      :class:`BufferedIOBase` deals with.  This is not part of the
+      :class:`BufferedIOBase` API and may not exist on some implementations.
+
    .. method:: detach()
 
       Separate the underlying raw stream from the buffer and return it.
@@ -607,6 +613,12 @@ Text I/O
       A string, a tuple of strings, or ``None``, indicating the newlines
       translated so far.
 
+   .. attribute:: buffer
+
+      The underlying binary buffer (a :class:`BufferedIOBase` instance) that
+      :class:`TextIOBase` deals with.  This is not part of the
+      :class:`TextIOBase` API and may not exist on some implementations.
+
    .. method:: detach()
 
       Separate the underlying buffer from the :class:`TextIOBase` and return it.