[Python-checkins] cpython (2.7): Issue #20423: fix documentation of io.StringIO's newline parameter

Sun Feb 2 22:51:54 CET 2014

http://hg.python.org/cpython/rev/69a2cc048c80
changeset: 88908:69a2cc048c80
branch: 2.7
parent: 88903:515e6afd2f0f
user: Antoine Pitrou <solipsis at pitrou.net>
date: Sun Feb 02 22:48:25 2014 +0100
summary:
 Issue #20423: fix documentation of io.StringIO's newline parameter
files:
 Doc/library/io.rst | 6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/Doc/library/io.rst b/Doc/library/io.rst
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -791,14 +791,14 @@
 Whether line buffering is enabled.
 
 
-.. class:: StringIO(initial_value=u'', newline=None)
+.. class:: StringIO(initial_value=u'', newline=u'\\n')
 
 An in-memory stream for unicode text. It inherits :class:`TextIOWrapper`.
 
 The initial value of the buffer (an empty unicode 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.
+ that of :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:`TextIOWrapper` and its parents:
-- 
Repository URL: http://hg.python.org/cpython
