#14912 closed (fixed)
urlize and urlizetrunc template filter docs need expansion
Reported by: | Gabriel Hurley | Owned by: | Gabriel Hurley |
---|---|---|---|
Component: | Documentation | Version: | 1.2 |
Severity: | Keywords: | ||
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description (last modified by )
I was looking at the source code for the urlize filter today and realized the following:
- The docstring for
django.utils.html.urlize
has much better documentation than the reference docs do. - The
autoescape
keyword argument to both theurlize
andurlizetrunc
template filters is not documented. - The
nofollow
argument todjango.utils.html.urlize
is always passed asTrue
bydjango.template.defaultfilters.urlize
anddjango.template.defaultfilters.urlizetrunc
. While this is a good default, it definitely needs to be documented.
All of the above needs to be incorporated into the docs for those two filters, and they need both more and better examples.
Attachments (1)
Change History (6)
comment:1 by , 14 years ago
Description: | modified (diff) |
---|
by , 14 years ago
Attachment: | urlize.diff added |
---|
comment:2 by , 14 years ago
Has patch: | set |
---|---|
Triage Stage: | Unreviewed → Accepted |
comment:3 by , 14 years ago
Resolution: | → fixed |
---|---|
Status: | new → closed |
comment:4 by , 14 years ago
Note:
See TracTickets
for help on using tickets.
(In [15086]) Fixed #14912 -- Expanded documentation for the urlize template filter. Thanks to adamv for the draft patch.