From: R David Murray <rdmurray@bitdance.com>
Date: Fri, 1 Jun 2012 20:21:06 +0000 (-0400)
Subject: #14957: clarify splitlines docs.
X-Git-Tag: v2.7.4rc1~778
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4fbf7c61fea1cdce8487ed9582ab9ba73fcf53ea;p=python

#14957: clarify splitlines docs.

Initial patch by Michael Driscoll, I added the example.
---

diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index cebe7528e8..66faccac2e 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -1185,7 +1185,13 @@ string functions based on regular expressions.
 
    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.
+   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.
+
+   For example, ``'ab c\n\nde fg\rkl\r\n'.splitlines()`` returns
+   ``['ab c', '', 'de fg', 'kl']``, while the same call with ``splinelines(True)``
+   returns ``['ab c\n', '\n, 'de fg\r', 'kl\r\n']``.
 
 
 .. method:: str.startswith(prefix[, start[, end]])