[Django] #33067: Acknowledge existence of verbatim template tag in templatetag documentation
Django
------------------------------------------------+------------------------
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.
Django
Reporter: Chris Jerdonek | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: dev
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* stage: Unreviewed => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/33067#comment:1>
Django
Reporter: Chris Jerdonek | Owner: Muhammad
Type: | Hammad
Cleanup/optimization | Status: assigned
Component: Documentation | Version: dev
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Muhammad Hammad):
* owner: nobody => Muhammad Hammad
* status: new => assigned
--
Ticket URL: <https://code.djangoproject.com/ticket/33067#comment:2>
Django
Reporter: Chris Jerdonek | Owner: Muhammad
Type: | Hammad
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* needs_better_patch: 0 => 1
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/14817 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/33067#comment:3>
Django
Reporter: Chris Jerdonek | Owner: Muhammad
Type: | Hammad
Cleanup/optimization | Status: assigned
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak):
* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/33067#comment:4>
Django
Reporter: Chris Jerdonek | Owner: Muhammad
Type: | Hammad
Component: Documentation | Version: dev
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Mariusz Felisiak <felisiak.mariusz@…>):
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"f1d2d2679bfcafa650b840bb3f187b9483d04f77" f1d2d26]:
{{{
#!CommitTicketReference repository=""
revision="f1d2d2679bfcafa650b840bb3f187b9483d04f77"
Fixed #33067 -- Improved templatetag docs.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/33067#comment:5>