Opened 9 years ago

Closed 9 years ago

#4307 closed (fixed)

Unclear location of ROOT_URLCONF in tutorial 3

Reported by: rogerpack2005@… Owned by: jacob
Component: Documentation Version: master
Severity: Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:


In tutorial 3 it says that "When you ran python startproject mysite at the beginning of Tutorial 1, it created a default URLconf in mysite/ It also automatically set your ROOT_URLCONF setting to point at that file:

ROOT_URLCONF = 'mysite.urls'

in reality we ran " startproject mysite"
and it did not set up a default ROOT_URLCONF.

Change History (5)

comment:1 Changed 9 years ago by rogerpack2005@…

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

Oops I was confused. What it failed to mention was that ROOT_URLCONF is automatically setup "in" -- I thought it was auto set up in, as the documentation made me think it was. thanks!

comment:2 Changed 9 years ago by SmileyChris

  • Summary changed from typo in tutorial 3 to Unclear location of ROOT_URLCONF in tutorial 3
  • Triage Stage changed from Unreviewed to Accepted

Thanks for the report Roger. While the implicit wording of "setting" makes it obvious to veterans, you bring up a good point that it could be said more explicitly.

If you feel up to it, it is always appreciated if you could provide a patch. Update the documentation file with the more explicit instructions, create the diff and attach to this ticket.

comment:3 Changed 9 years ago by roger

so diff the html output?

comment:4 Changed 9 years ago by SmileyChris

Checkout the SVN, edit the documentation txt file (restructured text format) and attach the diff.

comment:5 Changed 9 years ago by mtredinnick

  • Resolution set to fixed
  • Status changed from new to closed

(In [5365]) Fixed #4307 -- Clarified that ROOT_URLCONF is in and fixed a small
typo. Pointed out by rogerpack2005@….

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