]> granicus.if.org Git - python/commitdiff
Issue #20423: fix documentation of io.StringIO's newline parameter
authorAntoine Pitrou <solipsis@pitrou.net>
Sun, 2 Feb 2014 21:48:25 +0000 (22:48 +0100)
committerAntoine Pitrou <solipsis@pitrou.net>
Sun, 2 Feb 2014 21:48:25 +0000 (22:48 +0100)
Doc/library/io.rst

index bd0ce67470e6a630c621f82f962db8941f5e1519..3d723c09db2a3a3bd02a560b265ded6bd9fd7bad 100644 (file)
@@ -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: