summaryrefslogtreecommitdiff
path: root/Doc/library/string.rst
diff options
context:
space:
mode:
authorBarry Warsaw <barry@python.org>2015-06-09 14:20:31 -0400
committerBarry Warsaw <barry@python.org>2015-06-09 14:20:31 -0400
commit17d5f474238fc753bf4d28d458784a0e2e6d3cd9 (patch)
tree6b0299f8bf3bb5df7ffdb3af59f60124bb894cc7 /Doc/library/string.rst
parentf330d536910735ffa54f0fab136c04dbd0ee49dd (diff)
downloadcpython-git-17d5f474238fc753bf4d28d458784a0e2e6d3cd9.tar.gz
- Issue #24351: Clarify what is meant by "identifier" in the context of
string.Template instances.
Diffstat (limited to 'Doc/library/string.rst')
-rw-r--r--Doc/library/string.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/Doc/library/string.rst b/Doc/library/string.rst
index f9da5fa7ad..19bdb21b3e 100644
--- a/Doc/library/string.rst
+++ b/Doc/library/string.rst
@@ -640,12 +640,14 @@ Instead of the normal ``%``\ -based substitutions, Templates support ``$``\
* ``$$`` is an escape; it is replaced with a single ``$``.
* ``$identifier`` names a substitution placeholder matching a mapping key of
- ``"identifier"``. By default, ``"identifier"`` must spell a Python
- identifier. The first non-identifier character after the ``$`` character
- terminates this placeholder specification.
-
-* ``${identifier}`` is equivalent to ``$identifier``. It is required when valid
- identifier characters follow the placeholder but are not part of the
+ ``"identifier"``. By default, ``"identifier"`` is restricted to any
+ case-insensitive ASCII alphanumeric string (including underscores) that
+ starts with an underscore or ASCII letter. The first non-identifier
+ character after the ``$`` character terminates this placeholder
+ specification.
+
+* ``${identifier}`` is equivalent to ``$identifier``. It is required when
+ valid identifier characters follow the placeholder but are not part of the
placeholder, such as ``"${noun}ification"``.
Any other appearance of ``$`` in the string will result in a :exc:`ValueError`