Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#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: UI/UX:

Description (last modified by Gabriel Hurley)

I was looking at the source code for the urlize filter today and realized the following:

  1. The docstring for django.utils.html.urlize has much better documentation than the reference docs do.
  2. The autoescape keyword argument to both the urlize and urlizetrunc template filters is not documented.
  3. The nofollow argument to django.utils.html.urlize is always passed as True by django.template.defaultfilters.urlize and 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.

Attachments (1)

urlize.diff (1.3 KB) - added by Adam Vandenberg 6 years ago.

Download all attachments as: .zip

Change History (6)

comment:1 Changed 6 years ago by Gabriel Hurley

Description: modified (diff)

Changed 6 years ago by Adam Vandenberg

Attachment: urlize.diff added

comment:2 Changed 6 years ago by Claude Paroz

Has patch: set
Triage Stage: UnreviewedAccepted

comment:3 Changed 6 years ago by Gabriel Hurley

Resolution: fixed
Status: newclosed

(In [15086]) Fixed #14912 -- Expanded documentation for the urlize template filter. Thanks to adamv for the draft patch.

comment:4 Changed 6 years ago by Gabriel Hurley

(In [15087]) [1.2.X] Fixed #14912 -- Expanded documentation for the urlize template filter. Thanks to adamv for the draft patch.

Backport of [15086] from trunk.

comment:5 Changed 5 years ago by Jacob

milestone: 1.3

Milestone 1.3 deleted

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