Code

Opened 5 years ago

Closed 5 years ago

Last modified 5 years ago

#11272 closed (fixed)

Various minor errors in the tutorial

Reported by: jjinux Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description (last modified by gwilson)

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.

Attachments (0)

Change History (4)

comment:1 Changed 5 years ago by jjinux

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

By the way, nice job on a great tutorial :-D

comment:2 Changed 5 years ago by gwilson

  • Description modified (diff)

Fixed ticket formatting.

comment:3 Changed 5 years ago by russellm

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

(In [11044]) Fixed #11272 -- Made some clarifications to the overview and tutorial. Thanks to jjinux for the review notes.

comment:4 Changed 5 years ago by russellm

(In [11056]) [1.0.X] Fixed #11272 -- Made some clarifications to the overview and tutorial. Thanks to jjinux for the review notes.

Merge of r11044 from trunk.

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.