[issue20314] Potentially confusing formulation in 6.1.4. Template strings
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@python components: Documentation messages: 208553 nosy: Gerrit.Holl, docs@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@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Georg Brandl added the comment: +1. ---------- nosy: +georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Barry A. Warsaw added the comment: On Jan 20, 2014, at 05:10 PM, Gerrit Holl wrote:
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:
+1 PEP 292 templates predate .format(). ---------- nosy: +barry title: Potentially confusing formulation in 6.1.4. Template strings -> Potentially confusing formulation in 6.1.4. Template strings _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Zachary Ware added the comment: I would suggest moving the section "4.7.2. printf-style String Formatting" from stdtypes to string, alongside the other two formatting specifications, or otherwise moving %-formatting and {}-formatting into the same page that is not stdtypes. 4.7.2 is a pretty long section, and it seems odd to me that it is still in that page instead of with the other string formatting specs, though it is the only place that would have made sense in a pre-{}-and-$-formatting world. On the other hand, Gerrit's proposed solution is a *lot* simpler :) ---------- nosy: +zach.ware _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Changes by Zachary Ware <zachary.ware@gmail.com>: ---------- versions: +Python 2.7, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Georg Brandl added the comment:
I would suggest moving the section "4.7.2. printf-style String Formatting" from stdtypes to string
That's something I wanted to do for a long time. Problem is that non-Intersphinx external links will break (and I guess quite a few people have a bookmark on that section)... so it might be good to keep 4.7.2 with a pointer. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Changes by Barry A. Warsaw <barry@python.org>: ---------- assignee: docs@python -> barry _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Changes by Barry A. Warsaw <barry@python.org>: ---------- pull_requests: +759 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Barry A. Warsaw added the comment: New changeset 9f74deba784fc8781d13ed564f69c02ed7c331bb by Barry Warsaw in branch 'master': Improve the documentation for template strings (#856) https://github.com/python/cpython/commit/9f74deba784fc8781d13ed564f69c02ed7c... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Changes by Barry A. Warsaw <barry@python.org>: ---------- resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
Changes by Barry A. Warsaw <barry@python.org>: ---------- versions: +Python 3.7 -Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue20314> _______________________________________
participants (4)
-
Barry A. Warsaw -
Georg Brandl
-
Gerrit Holl
-
Zachary Ware