Opened 10 years ago

Closed 10 years ago

#23826 closed Cleanup/optimization (duplicate)

Better signposting in templatetags documentation

Reported by: Daniel Roseman Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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.

Change History (3)

comment:2 by Tim Graham, 10 years ago

Reordering these docs was previously suggested in #20435 - maybe you'd like to try to pick that up?

comment:3 by Daniel Roseman, 10 years ago

Resolution: → duplicate
Status: new → closed

Closing in favour of that ticket, as suggested: will add an updated PR there.

Note: See TracTickets for help on using tickets.
Back to Top