Skip to content

gh-106318: Improve str.rstrip() method doc #143893

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

Merged
vstinner merged 7 commits into from
Feb 11, 2026
+19 −4
Merged

gh-106318: Improve str.rstrip() method doc #143893

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1b401b4
gh-106318: Add doctest role to str.rsplit() method
adorilson Jan 15, 2026
9fa3ecc
gh-106318: Remove str.removesuffix() example from str.rsplit() method…
adorilson Jan 15, 2026
eb31bd6
Update Doc/library/stdtypes.rst
adorilson Jan 19, 2026
3e78e07
Merge branch 'main' into 106318.rstrip
StanFromIreland Feb 6, 2026
25ab03f
Revert "gh-106318: Remove str.removesuffix() example from str.rsplit(…
adorilson Feb 10, 2026
869cdd2
gh-106318: Add "See also" for str.rstrip() and str.strip() methods
adorilson Feb 10, 2026
ae431aa
gh-106318: Add doctest role for str.strip() method
adorilson Feb 10, 2026
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: 5 additions & 7 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2606,20 +2606,18 @@ expression support in the :mod:`re` module).
Return a copy of the string with trailing characters removed. The *chars*
argument is a string specifying the set of characters to be removed. If omitted
or ``None``, the *chars* argument defaults to removing whitespace. The *chars*
argument is not a suffix; rather, all combinations of its values are stripped::
argument is not a suffix; rather, all combinations of its values are stripped.
For example:

.. doctest::

>>> ' spacious '.rstrip()
' spacious'
>>> 'mississippi'.rstrip('ipz')
'mississ'

See :meth:`str.removesuffix` for a method that will remove a single suffix
string rather than all of a set of characters. For example::
See also :meth:`strip` and :meth:`removesuffix`.
Copy link
Copy Markdown
Member

@nedbat nedbat Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should keep the original for these lines.

  • it is eye-catching and surprising
  • It shows the two methods side-by-side.
  • it honors our forebearers.

Copy link
Copy Markdown
Member

@vstinner vstinner Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. I like these 'Monty Python' examples, I would also prefer to keep them.

Copy link
Copy Markdown
Contributor Author

@adorilson adorilson Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. With other improvements.


>>> 'Monty Python'.rstrip(' Python')
'M'
>>> 'Monty Python'.removesuffix(' Python')
'Monty'

.. method:: str.split(sep=None, maxsplit=-1)

Expand Down
Loading