#25711: The project template's URLconf doesn't follow the docs' convention for
include()
-------------------------------+------------------------------------
Reporter: EvilDMP | Owner: EvilDMP
Type: Bug | Status: assigned
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+------------------------------------
Changes (by knbk):
* type: Uncategorized => Bug
* stage: Unreviewed => Accepted
Comment:
Consistency is good, but keep in mind that there are actually three ways
to include urls:
1. A dotted string: `include('polls.urls')`
2. A module containing an `url_patterns` attribute: `from polls import
urls; include(urls)`
3. A list containing patterns: `from polls.urls import url_patterns;
include(url_patterns)`
Method 3 is only ever used to include a list of patterns that's defined in
the same file. Other than that, method 1 is used consistently in all but
the default project template, where it was added in #24635. The ticket
only mentions the dotted view path, but the patch also changes the example
for include.
The convention in the docs is to use a dotted path to include other
URLconf files. In that light, the change in #24635 is simply overzealous
and the current description in the project template is a bug.
I don't think the convention should be changed from method 1 to method 2.
If you'd like to discuss this, I think we should do so on the mailing
list.
--
Ticket URL: <https://code.djangoproject.com/ticket/25711#comment:3>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/065.736a915a662bb2fc7e4f7e01c4d11c2f%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
