summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorR David Murray <rdmurray@bitdance.com>2012-08-06 20:09:09 (GMT)
committerR David Murray <rdmurray@bitdance.com>2012-08-06 20:09:09 (GMT)
commitdecdb74227c3f4d791642f1496447b99b8ac7816 (patch)
tree449af13ff6d101b80dbe95f64bbfb89abf82bfb1 /Doc
parent670280470d1da26eb047584ed6e6c22f36bb01f2 (diff)
downloadcpython-decdb74227c3f4d791642f1496447b99b8ac7816.zip
cpython-decdb74227c3f4d791642f1496447b99b8ac7816.tar.gz
cpython-decdb74227c3f4d791642f1496447b99b8ac7816.tar.bz2
#15554: clarify splitlines/split differences.
Patch by Chris Jerdonek.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/stdtypes.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/Doc/library/stdtypes.rst b/Doc/library/stdtypes.rst
index 162b692..a7a6fb1 100644
--- a/Doc/library/stdtypes.rst
+++ b/Doc/library/stdtypes.rst
@@ -1183,16 +1183,19 @@ string functions based on regular expressions.
.. 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]])