From 4fbf7c61fea1cdce8487ed9582ab9ba73fcf53ea Mon Sep 17 00:00:00 2001 From: R David Murray Date: Fri, 1 Jun 2012 16:21:06 -0400 Subject: [PATCH] #14957: clarify splitlines docs. Initial patch by Michael Driscoll, I added the example. --- Doc/library/stdtypes.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst index cebe7528e81..66faccac2ed 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]])