From c7b8f809e773209dd12fa67af867786219d834e5 Mon Sep 17 00:00:00 2001 From: R David Murray Date: Wed, 15 Aug 2012 11:22:58 -0400 Subject: [PATCH] #15543: reflow paragraphs. --- Doc/library/functions.rst | 19 +++++++++---------- Doc/library/io.rst | 20 +++++++++----------- Doc/library/subprocess.rst | 11 +++++------ Doc/library/urllib.rst | 21 +++++++++++---------- Doc/whatsnew/2.3.rst | 13 ++++++------- Doc/whatsnew/2.5.rst | 11 ++++++----- Misc/ACKS | 1 + 7 files changed, 47 insertions(+), 49 deletions(-) diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 4383cd4e5a6..8d8027155d8 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -864,16 +864,15 @@ available. They are listed here in alphabetical order. In addition to the standard :c:func:`fopen` values *mode* may be ``'U'`` or ``'rU'``. Python is usually built with :term:`universal newlines` support; - supplying - ``'U'`` opens the file as a text file, but lines may be terminated by any of the - following: the Unix end-of-line convention ``'\n'``, the Macintosh convention - ``'\r'``, or the Windows convention ``'\r\n'``. All of these external - representations are seen as ``'\n'`` by the Python program. If Python is built - without universal newlines support a *mode* with ``'U'`` is the same as normal - text mode. Note that file objects so opened also have an attribute called - :attr:`newlines` which has a value of ``None`` (if no newlines have yet been - seen), ``'\n'``, ``'\r'``, ``'\r\n'``, or a tuple containing all the newline - types seen. + supplying ``'U'`` opens the file as a text file, but lines may be terminated + by any of the following: the Unix end-of-line convention ``'\n'``, the + Macintosh convention ``'\r'``, or the Windows convention ``'\r\n'``. All of + these external representations are seen as ``'\n'`` by the Python program. + If Python is built without universal newlines support a *mode* with ``'U'`` + is the same as normal text mode. Note that file objects so opened also have + an attribute called :attr:`newlines` which has a value of ``None`` (if no + newlines have yet been seen), ``'\n'``, ``'\r'``, ``'\r\n'``, or a tuple + containing all the newline types seen. Python enforces that the mode, after stripping ``'U'``, begins with ``'r'``, ``'w'`` or ``'a'``. diff --git a/Doc/library/io.rst b/Doc/library/io.rst index bb7c34fb486..899408687b7 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -144,10 +144,9 @@ Module Interface .. index:: single: universal newlines; open() (in module io) - *newline* controls how :term:`universal newlines` works (it only applies - to text - mode). It can be ``None``, ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It - works as follows: + *newline* controls how :term:`universal newlines` works (it only applies to + text 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 @@ -765,13 +764,12 @@ Text I/O ``''``, ``'\n'``, ``'\r'``, and ``'\r\n'``. It works as follows: * On input, if *newline* is ``None``, :term:`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 newlines 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. + 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 newlines 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 diff --git a/Doc/library/subprocess.rst b/Doc/library/subprocess.rst index 9f823235b48..348c505011f 100644 --- a/Doc/library/subprocess.rst +++ b/Doc/library/subprocess.rst @@ -385,12 +385,11 @@ functions. .. _side-by-side assembly: http://en.wikipedia.org/wiki/Side-by-Side_Assembly - If *universal_newlines* is ``True``, the file objects *stdout* and *stderr* are - opened as text files in :term:`universal newlines` mode. Lines may be - terminated by any of ``'\n'``, the Unix - end-of-line convention, ``'\r'``, the old Macintosh convention or ``'\r\n'``, the - Windows convention. All of these external representations are seen as ``'\n'`` - by the Python program. + If *universal_newlines* is ``True``, the file objects *stdout* and *stderr* + are opened as text files in :term:`universal newlines` mode. Lines may be + terminated by any of ``'\n'``, the Unix end-of-line convention, ``'\r'``, + the old Macintosh convention or ``'\r\n'``, the Windows convention. All of + these external representations are seen as ``'\n'`` by the Python program. .. note:: diff --git a/Doc/library/urllib.rst b/Doc/library/urllib.rst index 1cb3faf4125..2008bdfe3e7 100644 --- a/Doc/library/urllib.rst +++ b/Doc/library/urllib.rst @@ -32,16 +32,17 @@ High-level interface .. function:: urlopen(url[, data[, proxies]]) - Open a network object denoted by a URL for reading. If the URL does not have a - scheme identifier, or if it has :file:`file:` as its scheme identifier, this - opens a local file (without :term:`universal newlines`); otherwise it opens a socket to - a server somewhere on the network. If the connection cannot be made the - :exc:`IOError` exception is raised. If all went well, a file-like object is - returned. This supports the following methods: :meth:`read`, :meth:`readline`, - :meth:`readlines`, :meth:`fileno`, :meth:`close`, :meth:`info`, :meth:`getcode` and - :meth:`geturl`. It also has proper support for the :term:`iterator` protocol. One - caveat: the :meth:`read` method, if the size argument is omitted or negative, - may not read until the end of the data stream; there is no good way to determine + Open a network object denoted by a URL for reading. If the URL does not + have a scheme identifier, or if it has :file:`file:` as its scheme + identifier, this opens a local file (without :term:`universal newlines`); + otherwise it opens a socket to a server somewhere on the network. If the + connection cannot be made the :exc:`IOError` exception is raised. If all + went well, a file-like object is returned. This supports the following + methods: :meth:`read`, :meth:`readline`, :meth:`readlines`, :meth:`fileno`, + :meth:`close`, :meth:`info`, :meth:`getcode` and :meth:`geturl`. It also + has proper support for the :term:`iterator` protocol. One caveat: the + :meth:`read` method, if the size argument is omitted or negative, may not + read until the end of the data stream; there is no good way to determine that the entire stream from a socket has been read in the general case. Except for the :meth:`info`, :meth:`getcode` and :meth:`geturl` methods, diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index fbde6e54565..85fea682324 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -379,13 +379,12 @@ mark the ends of lines in text files. Unix uses the linefeed (ASCII character 10), MacOS uses the carriage return (ASCII character 13), and Windows uses a two-character sequence of a carriage return plus a newline. -Python's file objects can now support end of line conventions other than the one -followed by the platform on which Python is running. Opening a file with the -mode ``'U'`` or ``'rU'`` will open a file for reading in -:term:`universal newlines` mode. -All three line ending conventions will be translated to a ``'\n'`` in the -strings returned by the various file methods such as :meth:`read` and -:meth:`readline`. +Python's file objects can now support end of line conventions other than the +one followed by the platform on which Python is running. Opening a file with +the mode ``'U'`` or ``'rU'`` will open a file for reading in :term:`universal +newlines` mode. All three line ending conventions will be translated to a +``'\n'`` in the strings returned by the various file methods such as +:meth:`read` and :meth:`readline`. Universal newline support is also used when importing modules and when executing a file with the :func:`execfile` function. This means that Python modules can diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst index 503302449f0..e059cd50a33 100644 --- a/Doc/whatsnew/2.5.rst +++ b/Doc/whatsnew/2.5.rst @@ -1343,11 +1343,12 @@ complete list of changes, or look through the SVN logs for all the details. * The :mod:`fileinput` module was made more flexible. Unicode filenames are now supported, and a *mode* parameter that defaults to ``"r"`` was added to the - :func:`input` function to allow opening files in binary or :term:`universal newlines` - mode. Another new parameter, *openhook*, lets you use a function other than - :func:`open` to open the input files. Once you're iterating over the set of - files, the :class:`FileInput` object's new :meth:`fileno` returns the file - descriptor for the currently opened file. (Contributed by Georg Brandl.) + :func:`input` function to allow opening files in binary or :term:`universal + newlines` mode. Another new parameter, *openhook*, lets you use a function + other than :func:`open` to open the input files. Once you're iterating over + the set of files, the :class:`FileInput` object's new :meth:`fileno` returns + the file descriptor for the currently opened file. (Contributed by Georg + Brandl.) * In the :mod:`gc` module, the new :func:`get_count` function returns a 3-tuple containing the current collection counts for the three GC generations. This is diff --git a/Misc/ACKS b/Misc/ACKS index 96dd83779f9..1fad05b7ebf 100644 --- a/Misc/ACKS +++ b/Misc/ACKS @@ -418,6 +418,7 @@ Thomas Jarosch Drew Jenkins Flemming Kjær Jensen Philip Jenvey +Chris Jerdonek Jiba Orjan Johansen Fredrik Johansson