Skip to content

gh-106318: Add doctest role for str.splitlines() examples #144368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
adorilson wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −3
Open

gh-106318: Add doctest role for str.splitlines() examples #144368

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2704,7 +2704,9 @@ expression support in the :mod:`re` module).

``\v`` and ``\f`` added to list of line boundaries.

For example::
For example:

.. doctest::

>>> 'ab c\n\nde fg\rkl\r\n'.splitlines()
['ab c', '', 'de fg', 'kl']
Expand All @@ -2713,14 +2715,18 @@ expression support in the :mod:`re` module).

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::
break does not result in an extra line:

.. doctest::

>>> "".splitlines()
[]
>>> "One line\n".splitlines()
['One line']

For comparison, ``split('\n')`` gives::
For comparison, ``split('\n')`` gives:

.. doctest::

>>> ''.split('\n')
['']
Expand Down
Loading