#16051 closed Cleanup/optimization (fixed)
Misleading information in Writing your first Django app, part 3
| Reported by: | Owned by: | ShawnMilo | |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
Go to: https://docs.djangoproject.com/en/1.3/intro/tutorial03/
Locate the line saying "Your polls.urls file should now look like this:"
This information is misleading since the file really is "polls/urls.py". Someone on the #django IRC channel pointed out that "polls.urls" is a Python module, not a file. This is a Python specific notation nowhere mentioned in the tutorial. A note should be written concerning this information for users like me that are not familiar with Django nor Python. I think it is not a good idea to assume that Django users are familiar with Python, especially for a beginner tutorial.
Attachments (1)
Change History (6)
by , 14 years ago
| Attachment: | 16051.diff added |
|---|
comment:1 by , 14 years ago
| Easy pickings: | set |
|---|---|
| Has patch: | set |
| Owner: | changed from to |
| Triage Stage: | Unreviewed → Accepted |
comment:2 by , 14 years ago
| Component: | Djangoproject.com Web site → Documentation |
|---|---|
| Easy pickings: | unset |
| milestone: | → 1.4 |
| Triage Stage: | Accepted → Ready for checkin |
| Type: | New feature → Cleanup/optimization |
| Version: | 1.3 → SVN |
I agree that this makes things clearer. The text either refers to the URLconf polls.urls - as in (r'^polls/', include('polls.urls')) - or it refers to the file polls/urls.py. In this case it is the file being referred to.
The patch applies cleanly to the latest trunk in SVN.
Tiny doc patch.