Skip to content

gh-72798: Add mapping example to str.translate documentation #144454

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
kovan wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Open

gh-72798: Add mapping example to str.translate documentation #144454

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
6 changes: 6 additions & 0 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2833,6 +2833,12 @@ expression support in the :mod:`re` module).
You can use :meth:`str.maketrans` to create a translation map from
character-to-character mappings in different formats.

The following example uses a mapping to replace ``'a'`` with ``'X'``,
``'b'`` with ``'Y'``, and delete ``'c'``::
Copy link
Member

@vstinner vstinner Feb 5, 2026

Choose a reason for hiding this comment

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

Can you use .. doctest:: here?

Copy link
Contributor Author

@kovan kovan Feb 6, 2026

Choose a reason for hiding this comment

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

The other examples in stdtypes.rst (e.g. the str.title() example just above) consistently use :: with >>> prompts rather than .. doctest::. I kept the same style for consistency. Would you still prefer .. doctest:: here?


>>> 'abc123'.translate({ord('a'): 'X', ord('b'): 'Y', ord('c'): None})
'XY123'

See also the :mod:`codecs` module for a more flexible approach to custom
character mappings.

Expand Down
Loading