diff options
| author | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-08-13 09:59:00 (GMT) |
|---|---|---|
| committer | Andrew Svetlov <andrew.svetlov@gmail.com> | 2012-08-13 09:59:00 (GMT) |
| commit | e4b1a189a763824c226d804e5e73b826e7d7b70f (patch) | |
| tree | ad4044eb2318c5feb8f07d2f1bbb558fab503fd2 /Doc/library/functions.rst | |
| parent | b2d850248502ea3d76af42476661e40812986273 (diff) | |
| parent | ecd78feb7896239e062b8085c073affb8fd1fafa (diff) | |
| download | cpython-e4b1a189a763824c226d804e5e73b826e7d7b70f.zip cpython-e4b1a189a763824c226d804e5e73b826e7d7b70f.tar.gz cpython-e4b1a189a763824c226d804e5e73b826e7d7b70f.tar.bz2 | |
Issue #15624: clarify newline documentation for open and io.TextIOWrapper
Thanks to Chris Jerdonek
Diffstat (limited to 'Doc/library/functions.rst')
| -rw-r--r-- | Doc/library/functions.rst | 27 |
1 files changed, 15 insertions, 12 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index f23ccd7..c71475a 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -878,18 +878,21 @@ are always available. They are listed here in alphabetical order. mode). It can be ``None``, ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It works as follows: - * On input, if *newline* is ``None``, universal newlines mode is enabled. - Lines in the input can end in ``'\n'``, ``'\r'``, or ``'\r\n'``, and these - are translated into ``'\n'`` before being returned to the caller. If it is - ``''``, universal newline mode is enabled, but line endings are returned to - the caller untranslated. If it has any of the other legal values, input - lines are only terminated by the given string, and the line ending is - returned to the caller untranslated. - - * On output, if *newline* is ``None``, any ``'\n'`` characters written are - translated to the system default line separator, :data:`os.linesep`. If - *newline* is ``''`` or ``'\n'``, no translation takes place. If *newline* - is any of the other legal values, any ``'\n'`` characters written are + * When reading input from the stream, if *newline* is ``None``, + universal newlines mode is enabled. Lines in the input can end + in ``'\n'``, ``'\r'``, or ``'\r\n'``, and these are translated + into ``'\n'`` before being returned to the caller. If it is + ``''``, universal newline mode is enabled, but line endings are + returned to the caller untranslated. If it has any of the other + legal values, input lines are only terminated by the given + string, and the line ending is returned to the caller + untranslated. + + * When writing output to the stream, if *newline* is ``None``, any + ``'\n'`` characters written are translated to the system default + line separator, :data:`os.linesep`. If *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 |