[Python-checkins] cpython (merge 3.2 -> default): Merge #15554: clarify splitlines/split differences.

[r.david.murray]

http://hg.python.org/cpython/rev/0d6eea2330d0
changeset:   78454:0d6eea2330d0
parent:      78452:8282e4846e43
parent:      78453:768b188262e7
user:        R David Murray <rdmurray at bitdance.com>
date:        Mon Aug 06 16:08:40 2012 -0400
summary:
  Merge #15554: clarify splitlines/split differences.

Patch by Chris Jerdonek.

files:
  Doc/library/stdtypes.rst |  13 ++++++++-----
  1 files changed, 8 insertions(+), 5 deletions(-)


diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -1351,16 +1351,19 @@
 
 .. method:: str.splitlines([keepends])
 
-   Return a list of the lines in the string, breaking at line boundaries.  Line
-   breaks are not included in the resulting list unless *keepends* is given and
-   true. This method uses the universal newlines approach to splitting lines.
-   Unlike :meth:`~str.split`, if the string ends with line boundary characters
-   the returned list does ``not`` have an empty last element.
+   Return a list of the lines in the string, breaking at line boundaries.
+   This method uses the universal newlines approach to splitting lines.
+   Line breaks are not included in the resulting list unless *keepends* is
+   given and true.
 
    For example, ``'ab c\n\nde fg\rkl\r\n'.splitlines()`` returns
    ``['ab c', '', 'de fg', 'kl']``, while the same call with ``splitlines(True)``
    returns ``['ab c\n', '\n, 'de fg\r', 'kl\r\n']``.
 
+   Unlike :meth:`~str.split` when a delimiter string *sep* is given, this
+   method returns an empty list for the empty string, and a terminal line
+   break does not result in an extra line.
+
 
 .. method:: str.startswith(prefix[, start[, end]])
 

-- 
Repository URL: http://hg.python.org/cpython