I've just started learning Django from the Polls 
<https://docs.djangoproject.com/en/1.10/intro/tutorial01/> example which 
did not work for me after 30 minutes of really - and I mean *really* - 
checking that I had done exactly what I was told to do. I eventually found 
(i) I was not the first person to have exactly this problem and (ii) the 
cause is insufficiently clear instructions.

I would like to suggest that the documentation is improved along the lines 
set out below (assuming I am correct of course). How do I bring this matter 
to the attention of the people responsible?

For those interested, here's the issue:

The tutorial says

*The next step is to point the root URLconf at the polls.urls module. In 
mysite/urls.py*

I content this is incorrect or misleading. It should imo say

*The next step is to point the root URLconf at the polls.urls module. In 
mysite/mysite/urls.py*

One could argue that the former is correct but given that (a) this 
introductory/hand-holding material, (b) there are three files called 
urls.py in scope all with very similar contents and (c) more than one 
person has misunderstood the instruction, I think the latter is better.

A second issue is the instruction:

*Let’s write the first view. Open the file polls/views.py and put the 
following Python code in it:*

The issue is that the file concerned has already been created by this stage 
so "put" is ambiguous. It could mean "add" or "replace the current 
contents" with. It happens that the code referred to is all about the 
necessary imports for URLconf-ing which is exactly the context of the 
problem in the first issue.

-- 
You received this message because you are subscribed to the Google Groups 
"Django users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/django-users.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-users/31f6b09f-ef93-42d6-ad3b-e187761072e0%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to