Opened 11 years ago

Closed 11 years ago

Last modified 11 years ago

#20146 closed Bug (fixed)

Incorrect documentation for "remove_tags" method in django.utils.html

Reported by: helmut@… Owned by: ferhatelmas
Component: Documentation Version: 1.5
Severity: Normal Keywords:
Cc: bmispelon@… Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

This refers to the documentation for the "remove_tags" method on the following page:
https://docs.djangoproject.com/en/1.5/ref/utils/#module-django.utils.html

The documentation shows an example where the "tags" parameter for this method is given as a list, but in actual fact, the method expects a string (space separated, I assume). Passing in a list for that parameter results in an error:
AttributeError: 'list' object has no attribute 'split'.

Change History (6)

comment:1 by Tim Graham, 11 years ago

Triage Stage: UnreviewedAccepted
Type: UncategorizedBug

comment:2 by ferhatelmas, 11 years ago

Owner: changed from nobody to ferhatelmas
Status: newassigned

comment:4 by Baptiste Mispelon, 11 years ago

Cc: bmispelon@… added
Triage Stage: AcceptedReady for checkin

The patch looks good.

comment:5 by Claude Paroz <claude@…>, 11 years ago

Resolution: fixed
Status: assignedclosed

In e5d252f5b9bc586a61113943f13e8fe6147d9e3d:

Fixed #20146 -- Updated removed_tags example

comment:6 by Claude Paroz <claude@…>, 11 years ago

In 56d4356d8cb6e683c354a4b8f22a17d37624d6e8:

[1.5.x] Fixed #20146 -- Updated removed_tags example

Backport of e5d252f5b9 from master.

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