summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRonald Oussoren <ronaldoussoren@mac.com>2013-07-07 07:26:45 (GMT)
committerRonald Oussoren <ronaldoussoren@mac.com>2013-07-07 07:26:45 (GMT)
commit385521c90e35565ceb1bc54ab31b217321fd2d84 (patch)
treee97fe0b7c64d5035508717b3de262ec0d86e6c46
parenta53cca3fea655e19a9b98d14c514dcc4c2f780fe (diff)
downloadcpython-385521c90e35565ceb1bc54ab31b217321fd2d84.zip
cpython-385521c90e35565ceb1bc54ab31b217321fd2d84.tar.gz
cpython-385521c90e35565ceb1bc54ab31b217321fd2d84.tar.bz2
Cleanup of documentation change from #17860
Reformulated the textual change, and applied it to the docstring as well.
-rw-r--r--Doc/library/subprocess.rst11
-rw-r--r--Lib/subprocess.py3
2 files changed, 10 insertions, 4 deletions
diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst
index cf9fd0b..3a30821 100644
--- a/Doc/library/subprocess.rst
+++ b/Doc/library/subprocess.rst
@@ -290,11 +290,14 @@ default values. The arguments that are most commonly needed are:
.. index::
single: universal newlines; subprocess module
- If *universal_newlines* is ``True``, the file objects *stdin*, *stdout* and
- *stderr* will be opened as text streams in :term:`universal newlines` mode
+ If *universal_newlines* is ``False`` the file objects *stdin*, *stdout* and
+ *stderr* will be opened as binary streams, and no line ending conversion is
+ done.
+
+ If *universal_newlines* is ``True``, these file objects
+ will be opened as text streams in :term:`universal newlines` mode
using the encoding returned by :func:`locale.getpreferredencoding(False)
- <locale.getpreferredencoding>`, otherwise these streams will be opened
- as binary streams. For *stdin*, line ending characters
+ <locale.getpreferredencoding>`. For *stdin*, line ending characters
``'\n'`` in the input will be converted to the default line separator
:data:`os.linesep`. For *stdout* and *stderr*, all line endings in the
output will be converted to ``'\n'``. For more information see the
diff --git a/Lib/subprocess.py b/Lib/subprocess.py
index a62d9a4..35086ac 100644
--- a/Lib/subprocess.py
+++ b/Lib/subprocess.py
@@ -104,6 +104,9 @@ in the child process prior to executing the command.
If env is not None, it defines the environment variables for the new
process.
+If universal_newlines is false, the file objects stdin, stdout and stderr
+are opened as binary files, and no line ending conversion is done.
+
If universal_newlines is true, the file objects stdout and stderr are
opened as a text files, but lines may be terminated by any of '\n',
the Unix end-of-line convention, '\r', the old Macintosh convention or