[issue20314] Potentially confusing formulation in 6.1.4. Template strings
Gerrit Holl
report at bugs.python.org
Mon Jan 20 18:10:54 CET 2014
New submission from Gerrit Holl:
The standard library documentation “6.1. string — Common string operations” describes string formatting through the `.format` method and the corresponding mini-language, and the `Template` class. In the part describing the `Template` class (6.1.4) is the text:
> Instead of the normal %-based substitutions, Templates support $-based substitutions, using the following rules:
This is potentially confusing. The documentation in this section has not made any mention of %-based substitutions. Rather, a novel reader may, at this point, think that {}-based substitution is normal. I would suggest to resolve this issue by simply not mentioning %-based substitutions, replacing the sentence above by:
> Templates support $-based substitutions, using the following rules:
----------
assignee: docs at python
components: Documentation
messages: 208553
nosy: Gerrit.Holl, docs at python
priority: normal
severity: normal
status: open
title: Potentially confusing formulation in 6.1.4. Template strings
type: enhancement
versions: Python 3.3
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue20314>
_______________________________________
More information about the Python-bugs-list
mailing list