Issue #14123: Explicitly mention that old style % string formatting has caveats

but is not going away any time soon.
This commit is contained in:
Gregory P. Smith 2012-02-26 01:54:07 -08:00
parent f527277b67
commit 3bbdc8e822
1 changed files with 7 additions and 2 deletions

View File

@ -1437,8 +1437,13 @@ Old String Formatting Operations
.. note::
The formatting operations described here are obsolete and may go away in future
versions of Python. Use the new :ref:`string-formatting` in new code.
The formatting operations described here are modelled on C's printf()
syntax. They only support formatting of certain builtin types. The
use of a binary operator means that care may be needed in order to
format tuples and dictionaries correctly. As the new
:ref:`string-formatting` syntax is more flexible and handles tuples and
dictionaries naturally, it is recommended for new code. However, there
are no current plans to deprecate printf-style formatting.
String objects have one unique built-in operation: the ``%`` operator (modulo).
This is also known as the string *formatting* or *interpolation* operator.