Opened 12 years ago

Closed 10 years ago

Last modified 10 years ago

#17707 closed Cleanup/optimization (fixed)

Docs for URL namespaces should explain the motivation and use cases

Reported by: Aymeric Augustin Owned by: nobody
Component: Documentation Version: dev
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

The docs are heavy on technical details, but very light on motivation and basic explanation: https://docs.djangoproject.com/en/dev/topics/http/urls/#url-namespaces

Apparently the decision was made here: https://code.djangoproject.com/ticket/10061#comment:53

A Google search for "django url namespaces" shows that I'm not the only person puzzled by this feature at first.

Change History (11)

comment:1 by Aymeric Augustin, 12 years ago

Triage Stage: UnreviewedAccepted

comment:2 by Adrien Lemaire, 12 years ago

Resolution: worksforme
Status: newclosed

I don't see any problem with the docs. Maybe you missed https://docs.djangoproject.com/en/dev/topics/http/urls/#defining-url-namespaces ?

The ticket you're refering to is quite old (django 1.1 milestone), same with the questions I can find on google for "django url namespaces" (2009/2010).

I guess we can close that ticket

comment:3 by Aymeric Augustin, 12 years ago

Resolution: worksforme
Status: closedreopened

As explained in the triage guidelines please dont close tickets as wontfix.

This was discussed with other members of the core team and they agreed there's room for improvement.

comment:4 by Adrien Lemaire, 12 years ago

ok sorry

comment:5 by Aymeric Augustin, 11 years ago

Status: reopenednew

comment:6 by Tim Graham, 11 years ago

Related: #20734 - "URL namespacing documentation should be clearer"

comment:7 by wim@…, 11 years ago

As a reference, I'd like to point to:
http://stackoverflow.com/questions/2126489/anyone-knows-good-django-url-namespaces-tutorial

David Eyk gives a very clear example on how to use them and that works for me.

comment:8 by Tim Graham, 10 years ago

See #17551 for a use case that is *not* intended.

comment:9 by Tim Graham, 10 years ago

Has patch: set

comment:10 by Tim Graham <timograham@…>, 10 years ago

Resolution: fixed
Status: newclosed

In a2bcec34918ba38a22b46aa5b24317c90fecf0b0:

Fixed #17707, #20734 -- Added examples to URL namespacing docs.

Thanks Daniele Procida for review.

comment:11 by Tim Graham <timograham@…>, 10 years ago

In 588afbb2be6cf03afde8e1b17980bea09f54ba9a:

[1.7.x] Fixed #17707, #20734 -- Added examples to URL namespacing docs.

Thanks Daniele Procida for review.

Backport of a2bcec3491 from master

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