Opened 7 years ago

Closed 7 years ago

Last modified 5 years ago

#13287 closed (fixed)

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

Reported by: rbarberac@… Owned by: Gabriel Hurley
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 Gabriel Hurley 7 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 7 years ago by Ramiro Morales

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 7 years ago by rbarberac@…

Component: UncategorizedDocumentation

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

comment:3 Changed 7 years ago by Russell Keith-Magee

Triage Stage: UnreviewedAccepted

Changed 7 years ago by Gabriel Hurley

Attachment: 13287_docs.diff added

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

comment:4 Changed 7 years ago by Gabriel Hurley

Has patch: set
Owner: changed from nobody to Gabriel Hurley
Status: newassigned

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

comment:5 Changed 7 years ago by Chris Beaven

Summary: Change in {% url %} arguments break existing codeDocumentation about {% url %} arguments still mentions comma separation

comment:6 Changed 7 years ago by Chris Beaven

Triage Stage: AcceptedReady for checkin

comment:7 Changed 7 years ago by Russell Keith-Magee

Resolution: fixed
Status: assignedclosed

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

comment:8 Changed 5 years ago by Jacob

milestone: 1.2

Milestone 1.2 deleted

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