[Django] #23826: Better signposting in templatetags documentation
Django
--------------------------------------+--------------------
Reporter: danielr | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 1
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
The templatetags documentation explains how to write a full compile/render
tag before introducing the shortcut decorators. This is unnecessarily
complicated for newcomers, and especially since the addition of
assignment_tag there is rarely a need to write a full implementation.
The attached PR adds signposts to the shortcut decorators in the section
introducing template tags. Alternatively, it may be better to rewrite the
section altogether to move the full implementation to the end.
--
Ticket URL: <https://code.djangoproject.com/ticket/23826>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: danielr | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by danielr):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Comment:
Pull request: https://github.com/django/django/pull/3511
--
Ticket URL: <https://code.djangoproject.com/ticket/23826#comment:1>
Django
Reporter: danielr | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Comment (by timgraham):
Reordering these docs was previously suggested in #20435 - maybe you'd
like to try to pick that up?
--
Ticket URL: <https://code.djangoproject.com/ticket/23826#comment:2>
Django
Reporter: danielr | Owner: nobody
Type: | Status: closed
Cleanup/optimization | Version: master
Component: Documentation | Resolution: duplicate
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Changes (by danielr):
* status: new => closed
* resolution: => duplicate
Comment:
Closing in favour of that ticket, as suggested: will add an updated PR
there.
--
Ticket URL: <https://code.djangoproject.com/ticket/23826#comment:3>