summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorMartin Panter <vadmium+py@gmail.com>2015-10-10 10:15:21 (GMT)
committerMartin Panter <vadmium+py@gmail.com>2015-10-10 10:15:21 (GMT)
commit994815e1d713428600386e9909b935e4dfe7c82d (patch)
tree274c577da68b7677123e88af723732c8b2ee2bbc /Doc/library
parent3cae7577723e094f6fab24001eb152efb23248a1 (diff)
parentcfad54344f570c1e833d92289ac571da7315b164 (diff)
downloadcpython-994815e1d713428600386e9909b935e4dfe7c82d.zip
cpython-994815e1d713428600386e9909b935e4dfe7c82d.tar.gz
cpython-994815e1d713428600386e9909b935e4dfe7c82d.tar.bz2
Issue #22413: Merge StringIO doc from 3.4 into 3.5
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/io.rst16
1 files changed, 12 insertions, 4 deletions
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 48fd226..cb3e9ed 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -889,10 +889,16 @@ Text I/O
An in-memory stream for text I/O. The text buffer is discarded when the
:meth:`~IOBase.close` method is called.
- The initial value of the buffer (an empty string by default) can be set by
- providing *initial_value*. The *newline* argument works like that of
- :class:`TextIOWrapper`. The default is to consider only ``\n`` characters
- as end of lines and to do no newline translation.
+ The initial value of the buffer can be set by providing *initial_value*.
+ If newline translation is enabled, newlines will be encoded as if by
+ :meth:`~TextIOBase.write`. The stream is positioned at the start of
+ the buffer.
+
+ The *newline* argument works like that of :class:`TextIOWrapper`.
+ The default is to consider only ``\n`` characters as ends of lines and
+ to do no newline translation. If *newline* is set to ``None``,
+ newlines are written as ``\n`` on all platforms, but universal
+ newline decoding is still performed when reading.
:class:`StringIO` provides this method in addition to those from
:class:`TextIOBase` and its parents:
@@ -900,6 +906,8 @@ Text I/O
.. method:: getvalue()
Return a ``str`` containing the entire contents of the buffer.
+ Newlines are decoded as if by :meth:`~TextIOBase.read`, although
+ the stream position is not changed.
Example usage::