Skip to content
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

Jump to bottom

Doc: printf-style library/stdtype improvements #16741

Merged
merged 11 commits into from
Mar 31, 2024
Merged

Doc: printf-style library/stdtype improvements #16741

Changes from 3 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cbd73ec
Doc: printf-style library/stdtype improvements
adorilson Oct 13, 2019
f66508c
[Doc]Fix example output in library/stdtypes
adorilson Oct 28, 2019
af91a45
Merge branch 'main' into printf_style
JelleZijlstra May 8, 2022
7839eaa
Merge branch 'main' into printf_style
adorilson Jun 10, 2023
6abf908
Doc: some adjustments in printf-style library/stdtype
adorilson Jun 10, 2023
f75ed95
Revert "Doc: some adjustments in printf-style library/stdtype"
adorilson Mar 31, 2024
70da987
Revert "[Doc]Fix example output in library/stdtypes"
adorilson Mar 31, 2024
8369b4f
Revert "Doc: printf-style library/stdtype improvements"
adorilson Mar 31, 2024
640c833
[Doc] Add simpler example to % operator in stdtypes
adorilson Mar 31, 2024
d43d3a5
[Doc] Add doctest directive to an example in stdtypes
adorilson Mar 31, 2024
34d63bc
Merge branch 'main' into printf_style
erlend-aasland Mar 31, 2024
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
17 changes: 10 additions & 7 deletions Doc/library/stdtypes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2276,15 +2276,18 @@ expression support in the :mod:`re` module).
alternatives provides their own trade-offs and benefits of simplicity,
flexibility, and/or extensibility.

String objects have one unique built-in operation: the ``%`` operator (modulo).
This is also known as the string *formatting* or *interpolation* operator.
Given ``format % values`` (where *format* is a string), ``%`` conversion
specifications in *format* are replaced with zero or more elements of *values*.
The effect is similar to using the :c:func:`sprintf` in the C language.
The % operator (modulo) can also be used for string formatting. Given ``'string'
% values``, instances of ``%`` in ``string`` are replaced with zero or more
elements of ``values``. This operation is commonly known as string
Copy link
Contributor

@slateny slateny Dec 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I'd have to agree with Jelle's comment and also note that what's common can be somewhat subjective (for example, I'd search with the query string formatting instead of string interpolation, despite the wikipedia page). Would you be interested in updating the PR to address the review?

interpolation. The effect is similar to using the :c:func:`sprintf` in the C
language. For example::

If *format* requires a single argument, *values* may be a single non-tuple
>>> print('%s has %d quote types.' % ('Python', 2))
Python has 2 quote types.

If *string* requires a single argument, *values* may be a single non-tuple
object. [5]_ Otherwise, *values* must be a tuple with exactly the number of
items specified by the format string, or a single mapping object (for example, a
items specified by the string, or a single mapping object (for example, a
dictionary).

.. index::
Expand Down