https://github.com/python/cpython/commit/a4b71283015b4a81d4280752f9ac0e0291cadf3f
commit: a4b71283015b4a81d4280752f9ac0e0291cadf3f
branch: main
author: dgpb <[email protected]>
committer: encukou <[email protected]>
date: 2025-04-30T14:24:40+02:00
summary:
gh-89867: string.Formatter auto numbering doc updates (GH-129617)
files:
M Doc/library/string.rst
diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index 5e2f35497cbe86..b44d98819b6998 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -131,16 +131,18 @@ implementation as the built-in :meth:`~str.format` method.
(which can happen if two replacement fields occur consecutively), then
*literal_text* will be a zero-length string. If there is no replacement
field, then the values of *field_name*, *format_spec* and *conversion*
- will be ``None``.
+ will be ``None``. The value of *field_name* is unmodified and
+ auto-numbering of non-numbered positional fields is done by
:meth:`vformat`.
.. method:: get_field(field_name, args, kwargs)
- Given *field_name* as returned by :meth:`parse` (see above), convert it
to
- an object to be formatted. Returns a tuple (obj, used_key). The default
- version takes strings of the form defined in :pep:`3101`, such as
- "0[name]" or "label.title". *args* and *kwargs* are as passed in to
- :meth:`vformat`. The return value *used_key* has the same meaning as the
- *key* parameter to :meth:`get_value`.
+ Given *field_name*, convert it to an object to be formatted.
+ Auto-numbering of *field_name* returned from :meth:`parse` is done by
+ :meth:`vformat` before calling this method. Returns a tuple (obj,
used_key).
+ The default version takes strings of the form defined in :pep:`3101`,
+ such as "0[name]" or "label.title". *args* and *kwargs* are as passed in
to
+ :meth:`vformat`. The return value *used_key* has the same meaning
+ as the *key* parameter to :meth:`get_value`.
.. method:: get_value(key, args, kwargs)
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
