Opened 15 years ago
Last modified 14 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
urlizehas much better documentation than the reference docs do. - The
autoescapekeyword argument to both theurlizeandurlizetrunctemplate filters is not documented. - The
limitargument tourlizetruncisn't explicitly documented and needs an example. - The the
nofollowargument todjango.utils.html.urlizeis always passed asTruebydjango.template.defaultfilters.urlizeanddjango.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.