#3007: remove stringio docs and fix a few nits in io docs.

birkenfeld · birkenfeld · commit 2932d9376e4d · 2008-05-30T06:27:09.000Z
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
@@ -630,9 +630,9 @@ Text I/O
 
 .. class:: StringIO([initial_value[, encoding[, errors[, newline]]]])
 
-   An in-memory stream for text.  It in inherits :class:`TextIOWrapper`.
+   An in-memory stream for text.  It inherits :class:`TextIOWrapper`.
 
-   Create a new StringIO stream with an inital value, encoding, error handling,
+   Create a new StringIO stream with an initial value, encoding, error handling,
    and newline setting.  See :class:`TextIOWrapper`\'s constructor for more
    information.
 
@@ -641,8 +641,25 @@ Text I/O
 
    .. method:: getvalue()
 
-      Return a ``str`` containing the entire contents of the buffer.
+      Return a ``str`` containing the entire contents of the buffer at any
+      time before the :class:`StringIO` object's :meth:`close` method is
+      called.
 
+   Example usage::
+
+      import io
+
+      output = io.StringIO()
+      output.write('First line.\n')
+      print('Second line.', file=output)
+
+      # Retrieve file contents -- this will be
+      # 'First line.\nSecond line.\n'
+      contents = output.getvalue()
+
+      # Close object and discard memory buffer -- 
+      # .getvalue() will now raise an exception.
+      output.close()
 
 .. class:: IncrementalNewlineDecoder
 
diff --git a/Doc/library/stringio.rst b/Doc/library/stringio.rst
diff --git a/Doc/library/strings.rst b/Doc/library/strings.rst
@@ -21,7 +21,6 @@ string functions based on regular expressions.
    re.rst
    struct.rst
    difflib.rst
-   stringio.rst
    textwrap.rst
    codecs.rst
    unicodedata.rst
