#33067: Acknowledge existence of verbatim template tag in templatetag
documentation
------------------------------------------------+------------------------
Reporter: Chris Jerdonek | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
Currently, the documentation for the `templatetag` template tag
[https://docs.djangoproject.com/en/3.2/ref/templates/builtins/#templatetag
says that you "must"] use `templatetag` in order to display one of the
syntax characters used to compose template tags:
> Since the template system has no concept of “escaping”, to display one
of the bits used in template tags, you must use the `{% templatetag %}`
tag.
However, this doesn't seem to acknowledge that the `verbatim` tag also
lets you do this. Thus, I would suggest rephrasing to something like--
> The template system has no concept of “escaping” individual characters.
However, you can use the {% templatetag %} tag to display one of the bits
used in template tags.
I would also include a sentence at the end that reads something like--
> See also the `verbatim` tag for another way of including these
characters.
By the way, I think the "Sample usage" example in the `templatetag` docs
might be better served by `verbatim` since it is a longer string with two
literal bits. I think the example for `templatetag` might be better if it
showed an isolated occurrence that doesn't have a matching pair.
--
Ticket URL: <https://code.djangoproject.com/ticket/33067>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/052.86df06bdecb4642fed2b06e107a5279c%40djangoproject.com.
