Opened 14 years ago
Last modified 13 years ago
#14912 closed
urlize and urlizetrunc template filter docs need expansion — at Initial Version
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
I was looking at the source code for the urlize filter today and realized the following:
- The docstring for the
urlize
has much better documentation than the reference docs do. - The
autoescape
keyword argument to both theurlize
andurlizetrunc
template filters is not documented. - The
limit
argument tourlizetrunc
isn't explicitly documented and needs an example. - The 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.
Note:
See TracTickets
for help on using tickets.