urlize and urlizetrunc template filter docs need expansion
|Reported by:||Gabriel Hurley||Owned by:||Gabriel Hurley|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||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.urlizehas much better documentation than the reference docs do.
autoescapekeyword argument to both the
urlizetrunctemplate filters is not documented.
django.utils.html.urlizeis always passed as
django.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.