Code

Opened 13 months ago

Closed 13 months ago

Last modified 13 months 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'.

Attachments (0)

Change History (6)

comment:1 Changed 13 months ago by timo

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Bug

comment:2 Changed 13 months ago by ferhatelmas

  • Owner changed from nobody to ferhatelmas
  • Status changed from new to assigned

comment:4 Changed 13 months ago by bmispelon

  • Cc bmispelon@… added
  • Triage Stage changed from Accepted to Ready for checkin

The patch looks good.

comment:5 Changed 13 months ago by Claude Paroz <claude@…>

  • Resolution set to fixed
  • Status changed from assigned to closed

In e5d252f5b9bc586a61113943f13e8fe6147d9e3d:

Fixed #20146 -- Updated removed_tags example

comment:6 Changed 13 months ago by Claude Paroz <claude@…>

In 56d4356d8cb6e683c354a4b8f22a17d37624d6e8:

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

Backport of e5d252f5b9 from master.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.