From: Antoine Pitrou <solipsis@pitrou.net>
Date: Sun, 2 Feb 2014 21:48:25 +0000 (+0100)
Subject: Issue #20423: fix documentation of io.StringIO's newline parameter
X-Git-Tag: v3.4.0rc1~117^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=be7ff9f2f9d659fb2061b373a9788a777a23b4b1;p=thirdparty%2FPython%2Fcpython.git

Issue #20423: fix documentation of io.StringIO's newline parameter
---

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index bd0ce67470e6..3d723c09db2a 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -844,13 +844,14 @@ Text I/O
       Whether line buffering is enabled.
 
 
-.. class:: StringIO(initial_value='', newline=None)
+.. class:: StringIO(initial_value='', newline='\\n')
 
    An in-memory stream for text I/O.
 
    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 do no newline translation.
+   :class:`TextIOWrapper`.  The default is to consider only ``\n`` characters
+   as end of lines and to do no newline translation.
 
    :class:`StringIO` provides this method in addition to those from
    :class:`TextIOBase` and its parents: