#11272: Various minor errors in the tutorial ------------------------------------+--------------------------------------- Reporter: jjinux | Owner: nobody Status: new | Milestone: Component: Documentation | Version: 1.0 Resolution: | Keywords: Stage: Unreviewed | Has_patch: 0 Needs_docs: 0 | Needs_tests: 0 Needs_better_patch: 0 | ------------------------------------+--------------------------------------- Old description:
> Here is a list of minor errors or improvements that I kept while I read > the tutorial: > > In http://docs.djangoproject.com/en/dev/intro/overview/#intro-overview: > > * This example doesn't indent the HTML in a for loop, but elsewhere in > the tutorial, they do. > > In http://docs.djangoproject.com/en/dev/intro/tutorial01/#intro- > tutorial01: > > * The phrase django.contrib.sessions isn't hyperlinked like the others > on this page. > > In http://docs.djangoproject.com/en/dev/intro/tutorial02/: > > * The grammar in the following is wrong: "The first register Choice > with the admin just as we did with Poll." > > In http://docs.djangoproject.com/en/dev/intro/tutorial03/#intro- > tutorial03: > > * It says, "When you ran python django-admin.py startproject mysite at > the beginning of Tutorial 1". Actually, it didn't say to use "python", > but rather to execute the script directly. > > * It says, "it loads the associated Python package/module: > mysite.polls.views.detail." "detail" isn't a module, it's a function. > > * It says, "Now that we've decoupled that, we need to decouple the > 'mysite.polls.urls' URLconf by removing the leading "polls/" from each > line:". It should be more explicit that you should get rid of all the > stuff related to admin. After all, the text did tell you to copy the > file mysite/urls.py to mysite/polls/urls.py. > > In http://docs.djangoproject.com/en/dev/intro/tutorial04/#intro- > tutorial04: > > * Since the tutorial aims to not couple the polls app to the mysite > project, it makes sense to remove the polls package from the mysite > package. Otherwise, you end up with the following stuff in the URLconf: > "(r'^(?P<poll_id>\d+)/vote/$', 'mysite.polls.views.vote')". In general, > 'egrep -r "mysite.polls" mysite' should find no matches. > > * There's a problem in using a relative URL for the form. If you go to > http://localhost:8001/polls/1/ and just click "Vote", it'll bring you to > http://localhost:8001/polls/1/vote/. If you click "Vote" again, you'll > get http://localhost:8001/polls/1/vote/vote/, which leads to a 404. Even > if you enter a valid value, clicking on "Vote" this second time around > will lead to a 404. New description: Here is a list of minor errors or improvements that I kept while I read the tutorial: In http://docs.djangoproject.com/en/dev/intro/overview/#intro-overview: * This example doesn't indent the HTML in a for loop, but elsewhere in the tutorial, they do. In http://docs.djangoproject.com/en/dev/intro/tutorial01/#intro- tutorial01: * The phrase django.contrib.sessions isn't hyperlinked like the others on this page. In http://docs.djangoproject.com/en/dev/intro/tutorial02/: * The grammar in the following is wrong: "The first register Choice with the admin just as we did with Poll." In http://docs.djangoproject.com/en/dev/intro/tutorial03/#intro- tutorial03: * It says, "When you ran python django-admin.py startproject mysite at the beginning of Tutorial 1". Actually, it didn't say to use "python", but rather to execute the script directly. * It says, "it loads the associated Python package/module: mysite.polls.views.detail." "detail" isn't a module, it's a function. * It says, "Now that we've decoupled that, we need to decouple the 'mysite.polls.urls' URLconf by removing the leading "polls/" from each line:". It should be more explicit that you should get rid of all the stuff related to admin. After all, the text did tell you to copy the file mysite/urls.py to mysite/polls/urls.py. In http://docs.djangoproject.com/en/dev/intro/tutorial04/#intro- tutorial04: * Since the tutorial aims to not couple the polls app to the mysite project, it makes sense to remove the polls package from the mysite package. Otherwise, you end up with the following stuff in the URLconf: `(r'^(?P<poll_id>\d+)/vote/$', 'mysite.polls.views.vote')`. In general, `egrep -r "mysite.polls" mysite` should find no matches. * There's a problem in using a relative URL for the form. If you go to http://localhost:8001/polls/1/ and just click "Vote", it'll bring you to http://localhost:8001/polls/1/vote/. If you click "Vote" again, you'll get http://localhost:8001/polls/1/vote/vote/, which leads to a 404. Even if you enter a valid value, clicking on "Vote" this second time around will lead to a 404. Comment (by gwilson): Fixed ticket formatting. -- Ticket URL: <http://code.djangoproject.com/ticket/11272#comment:2> Django <http://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 post to this group, send email to django-updates@googlegroups.com To unsubscribe from this group, send email to django-updates+unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/django-updates?hl=en -~----------~----~----~----~------~----~------~--~---