Code

Opened 4 years ago

Closed 4 years ago

Last modified 3 years ago

#13287 closed (fixed)

Documentation about {% url %} arguments still mentions comma separation

Reported by: rbarberac@… Owned by: gabrielhurley
Component: Documentation Version: master
Severity: Keywords:
Cc: SVN-12936 Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

Until 1.2 the {% url %} aditional arguments to the URL was a comma separated list. Now is a space separated list. In the documentation the samples show this new behavior but the text still says: "Additional arguments are optional and should be comma-separated values that will be used as arguments in the URL".

By the way, this change will have a deep impact in existing deployments using Django 1.1. Didn't was a priority to mantain backwards compability? At last this was what is printed here http://docs.djangoproject.com/en/dev/misc/api-stability/

Attachments (1)

13287_docs.diff (632 bytes) - added by gabrielhurley 4 years ago.
update reference to "comma-separated values" for url tag to "space-separated values"

Download all attachments as: .zip

Change History (9)

comment:1 in reply to: ↑ description Changed 4 years ago by ramiro

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

Replying to rbarberac@gmail.com:

Until 1.2 the {% url %} aditional arguments to the URL was a comma separated list. Now is a space separated list.

[...]

By the way, this change will have a deep impact in existing deployments using Django 1.1. Didn't was a priority to mantain backwards compability? At last this was what is printed here http://docs.djangoproject.com/en/dev/misc/api-stability/

If you are actually reading the docs that accompany the current SVN code and read all the documentation of the url tag you will see a section located at the bottom marked with Changed in Django Development version. that describes how backwards compatibility is being handled transparently.

Ticket #13275 is tracking some additional problems the backward-compatibility code has.

In the documentation the samples show this new behavior but the text still says: "Additional arguments are optional and should be comma-separated values that will be used as arguments in the URL".

That's an error in the documentation. maybe we shoudl switch this ticket to component: Documentation and correct that sentence to read "Additional arguments are optional and should be space-separated values that will be used as arguments in the URL"

comment:2 Changed 4 years ago by rbarberac@…

  • Component changed from Uncategorized to Documentation

Yes this is a documentation error. I've changed the ticket.

comment:3 Changed 4 years ago by russellm

  • Triage Stage changed from Unreviewed to Accepted

Changed 4 years ago by gabrielhurley

update reference to "comma-separated values" for url tag to "space-separated values"

comment:4 Changed 4 years ago by gabrielhurley

  • Has patch set
  • Owner changed from nobody to gabrielhurley
  • Status changed from new to assigned

Attached a patch that updates the only instance of that phrase in the docs as suggested by ramiro.

comment:5 Changed 4 years ago by SmileyChris

  • Summary changed from Change in {% url %} arguments break existing code to Documentation about {% url %} arguments still mentions comma separation

comment:6 Changed 4 years ago by SmileyChris

  • Triage Stage changed from Accepted to Ready for checkin

comment:7 Changed 4 years ago by russellm

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

(In [13107]) Fixed #13287 -- Corrected the advice on argument formatting in the {% url %} tag. Thanks to Gabriel Hurley for the report.

comment:8 Changed 3 years ago by jacob

  • milestone 1.2 deleted

Milestone 1.2 deleted

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.