summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVictor Stinner <victor.stinner@gmail.com>2012-08-03 23:18:56 (GMT)
committerVictor Stinner <victor.stinner@gmail.com>2012-08-03 23:18:56 (GMT)
commit401e17d0f06dd6594835424c5544689abdc0cc9f (patch)
tree7ed5e7ac7d7422b0c07f9c99f018722fd9cf568f
parent0c1c0d42dcc8fc223eb3aaa51d09d252b1738820 (diff)
downloadcpython-401e17d0f06dd6594835424c5544689abdc0cc9f.zip
cpython-401e17d0f06dd6594835424c5544689abdc0cc9f.tar.gz
cpython-401e17d0f06dd6594835424c5544689abdc0cc9f.tar.bz2
open() / TextIOWrapper doc: make it explicit than newline='\n' doesn't
translate newlines on output.
-rw-r--r--Doc/library/functions.rst6
-rw-r--r--Doc/library/io.rst6
-rw-r--r--Modules/_io/_iomodule.c6
-rw-r--r--Modules/_io/textio.c6
4 files changed, 12 insertions, 12 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index b6252e6..72bc7cb 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -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
diff --git a/Doc/library/io.rst b/Doc/library/io.rst
index 5f049c5..9aecc7d 100644
--- a/Doc/library/io.rst
+++ b/Doc/library/io.rst
@@ -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.
diff --git a/Modules/_io/_iomodule.c b/Modules/_io/_iomodule.c
index 4c90433..5987679 100644
--- a/Modules/_io/_iomodule.c
+++ b/Modules/_io/_iomodule.c
@@ -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"
diff --git a/Modules/_io/textio.c b/Modules/_io/textio.c
index 518108b..2d516ee 100644
--- a/Modules/_io/textio.c
+++ b/Modules/_io/textio.c
@@ -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."