Code

Opened 12 months ago

Last modified 5 months ago

#20734 new Cleanup/optimization

URL namespacing documentation should be clearer

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

Description

There are a couple of places in the documentation that refer to "application instances":

<https://docs.djangoproject.com/en/dev/topics/http/urls/#introduction>
<https://docs.djangoproject.com/en/dev/ref/contrib/admin/#multiple-admin-sites-in-the-same-urlconf>

However, it's not really clear what an application instance is or why I might need to deploy multiple instances of one.

I think that's worth explaining in the documentation, especially since I have found a number of questions and discussions on the subject elsewhere.

I'd suggest that the explanation be incorporated in the URLs documentation.

Attachments (0)

Change History (7)

comment:1 Changed 12 months ago by EvilDMP

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

Also:

Last edited 12 months ago by EvilDMP (previous) (diff)

comment:2 Changed 12 months ago by EvilDMP

And in https://docs.djangoproject.com/en/dev/intro/tutorial03/#namespacing-url-names, instead of namespace="polls", should we not be advising to use application="polls"?

Version 0, edited 12 months ago by EvilDMP (next)

comment:3 Changed 12 months ago by timo

Duplicate/related #17707?

comment:4 Changed 12 months ago by EvilDMP

Yes, there's some overlap. However, this one's a bit more specific, and also I once I start to get the answers clear in my head I will do some work on a patch to see if I can improve the documentation. How about a link from that one to this one?

comment:5 Changed 12 months ago by aaugustin

I have a file with notes from a discussion I had with Malcolm at DjangoCon US last year. I plan (at some point) to clarify the use case of url namespaces, and maybe to relax some constraints on their use. I want to do it because it's part of Malcolm's legacy but it hasn't reached the top of my TODO list for Django yet.

comment:6 Changed 12 months ago by timo

  • Triage Stage changed from Unreviewed to Accepted
  • Type changed from Uncategorized to Cleanup/optimization

comment:7 Changed 5 months ago by aaugustin

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as new
The owner will be changed from nobody to anonymous. Next status will be 'assigned'
as The resolution will be set. Next status will be 'closed'
Author


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

 
Note: See TracTickets for help on using tickets.