]> granicus.if.org Git - python/commitdiff
open() / TextIOWrapper doc: make it explicit than newline='\n' doesn't
authorVictor Stinner <victor.stinner@gmail.com>
Fri, 3 Aug 2012 23:18:56 +0000 (01:18 +0200)
committerVictor Stinner <victor.stinner@gmail.com>
Fri, 3 Aug 2012 23:18:56 +0000 (01:18 +0200)
translate newlines on output.

Doc/library/functions.rst
Doc/library/io.rst
Modules/_io/_iomodule.c
Modules/_io/textio.c

index b6252e629b3fa8dbb8852bedc31a7de790a7df15..72bc7cb909b25add74936ae45bd5bf1643b00d3b 100644 (file)
@@ -888,9 +888,9 @@ are always available.  They are listed here in alphabetical order.
 
    * On output, if *newline* is ``None``, any ``'\n'`` characters written are
      translated to the system default line separator, :data:`os.linesep`.  If
-     *newline* is ``''``, no translation takes place.  If *newline* is any of
-     the other legal values, any ``'\n'`` characters written are translated to
-     the given string.
+     *newline* is ``''`` or ``'\n'``, no translation takes place.  If *newline*
+     is any of the other legal values, any ``'\n'`` characters written are
+     translated to the given string.
 
    If *closefd* is ``False`` and a file descriptor rather than a filename was
    given, the underlying file descriptor will be kept open when the file is
index 5f049c552021ee84e648a7492320debc60b64bc9..9aecc7db6bf7cb9fea8c68421d316c60b295e124 100644 (file)
@@ -770,9 +770,9 @@ Text I/O
 
    * On output, if *newline* is ``None``, any ``'\n'`` characters written are
      translated to the system default line separator, :data:`os.linesep`.  If
-     *newline* is ``''``, no translation takes place.  If *newline* is any of
-     the other legal values, any ``'\n'`` characters written are translated to
-     the given string.
+     *newline* is ``''`` or ``'\n'``, no translation takes place.  If *newline*
+     is any of the other legal values, any ``'\n'`` characters written are
+     translated to the given string.
 
    If *line_buffering* is ``True``, :meth:`flush` is implied when a call to
    write contains a newline character.
index 4c90433ae97287fa526c85e57fbccd05c99616f6..59876791d80b4fd607af9d79710af3861839ee94 100644 (file)
@@ -264,9 +264,9 @@ PyDoc_STRVAR(open_doc,
 "\n"
 "* On output, if newline is None, any '\\n' characters written are\n"
 "  translated to the system default line separator, os.linesep. If\n"
-"  newline is '', no translation takes place. If newline is any of the\n"
-"  other legal values, any '\\n' characters written are translated to\n"
-"  the given string.\n"
+"  newline is '' or '\n', no translation takes place. If newline is any\n"
+"  of the other legal values, any '\\n' characters written are translated\n"
+"  to the given string.\n"
 "\n"
 "If closefd is False, the underlying file descriptor will be kept open\n"
 "when the file is closed. This does not work when a file name is given\n"
index 518108b00d539c6cc501807c48d7a08f963c37ab..2d516ee3ccdbb706a9ac60b6552103aec2ba2af2 100644 (file)
@@ -635,9 +635,9 @@ PyDoc_STRVAR(textiowrapper_doc,
     "\n"
     "* On output, if newline is None, any '\\n' characters written are\n"
     "  translated to the system default line separator, os.linesep. If\n"
-    "  newline is '', no translation takes place. If newline is any of the\n"
-    "  other legal values, any '\\n' characters written are translated to\n"
-    "  the given string.\n"
+    "  newline is '' or '\n', no translation takes place. If newline is any\n"
+    "  of the other legal values, any '\\n' characters written are translated\n"
+    "  to the given string.\n"
     "\n"
     "If line_buffering is True, a call to flush is implied when a call to\n"
     "write contains a newline character."