Re: [Django] #25711: The project template's URLconf doesn't follow the docs' convention for include()

[Django]

#25711: The project template's URLconf doesn't follow the docs' convention for
include()
---+
 Reporter:  EvilDMP|Owner:  EvilDMP
 Type:  Bug|   Status:  closed
Component:  Documentation  |  Version:  1.8
 Severity:  Normal |   Resolution:  fixed
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by Tim Graham ):

 In [changeset:"2c6624a67397afc0f72a36559b53fb693e473bbc" 2c6624a]:
 {{{
 #!CommitTicketReference repository=""
 revision="2c6624a67397afc0f72a36559b53fb693e473bbc"
 [1.9.x] Fixed #25711 -- Updated the project template's include() example.

 Referencing URLs by dotted path is a stronger convention than
 importing the URLs.

 Backport of 179fbab7e05946b59ec9815d6e9b1901826ed610 from master
 }}}

--
Ticket URL: 
Django 
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.8069227c8ee2fb2b82ee0a13cf5c26ef%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25711: The project template's URLconf doesn't follow the docs' convention for include()

[Django]

#25711: The project template's URLconf doesn't follow the docs' convention for
include()
---+
 Reporter:  EvilDMP|Owner:  EvilDMP
 Type:  Bug|   Status:  closed
Component:  Documentation  |  Version:  1.8
 Severity:  Normal |   Resolution:  fixed
 Keywords: | Triage Stage:  Accepted
Has patch:  0  |  Needs documentation:  0
  Needs tests:  0  |  Patch needs improvement:  0
Easy pickings:  0  |UI/UX:  0
---+

Comment (by Tim Graham ):

 In [changeset:"4211f8c9d1cd543d9c6fe4b789aea7dddf07c44a" 4211f8c9]:
 {{{
 #!CommitTicketReference repository=""
 revision="4211f8c9d1cd543d9c6fe4b789aea7dddf07c44a"
 [1.8.x] Fixed #25711 -- Updated the project template's include() example.

 Referencing URLs by dotted path is a stronger convention than
 importing the URLs.

 Backport of 179fbab7e05946b59ec9815d6e9b1901826ed610 from master
 }}}

--
Ticket URL: 
Django 
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.0edd9a9b317c4154f9a3ac2bf4e0d03b%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25711: The project template's URLconf doesn't follow the docs' convention for include()

[Django]

#25711: The project template's URLconf doesn't follow the docs' convention for
include()
---+
 Reporter:  EvilDMP|Owner:  EvilDMP
 Type:  Bug|   Status:  closed
Component:  Documentation  |  Version:  1.8
 Severity:  Normal |   Resolution:  fixed
 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 Tim Graham ):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"179fbab7e05946b59ec9815d6e9b1901826ed610" 179fbab7]:
 {{{
 #!CommitTicketReference repository=""
 revision="179fbab7e05946b59ec9815d6e9b1901826ed610"
 Fixed #25711 -- Updated the project template's include() example.

 Referencing URLs by dotted path is a stronger convention than
 importing the URLs.
 }}}

--
Ticket URL: 
Django 
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.534a2c3e944a7f134a395bb1e79079c2%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25711: The project template's URLconf doesn't follow the docs' convention for include()

[Django]

#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
---+

Comment (by EvilDMP):

 You're right, it is consistent when it comes to the docs (at least I can't
 find the example I thought I was looking at, or I just misread it in the
 first place).

 It should be explained though:

 * ''why'' the dotted string is preferred over e.g. `from polls import
 urls; include(urls)`
 * when if ever it would be better to use an imported module rather than a
 dotted string

--
Ticket URL: 
Django 
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.df38bc6901302b1a285218ae3920f73c%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #25711: The project template's URLconf doesn't follow the docs' convention for include() (was: django.conf.urls.include() documentation should be more consistent)

[Django]

#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: 
Django 
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.