Opened 6 years ago

Closed 6 years ago

Last modified 5 years ago

#16051 closed Cleanup/optimization (fixed)

Misleading information in Writing your first Django app, part 3

Reported by: felix.morency@… Owned by: ShawnMilo
Component: Documentation Version: master
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:

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)

16051.diff (608 bytes) - added by ShawnMilo 6 years ago.
Tiny doc patch.

Download all attachments as: .zip

Change History (6)

Changed 6 years ago by ShawnMilo

Attachment: 16051.diff added

Tiny doc patch.

comment:1 Changed 6 years ago by ShawnMilo

Easy pickings: set
Has patch: set
Owner: changed from nobody to ShawnMilo
Triage Stage: UnreviewedAccepted

comment:2 Changed 6 years ago by Graham King

Component: Djangoproject.com Web siteDocumentation
Easy pickings: unset
milestone: 1.4
Triage Stage: AcceptedReady for checkin
Type: New featureCleanup/optimization
Version: 1.3SVN

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.

comment:3 Changed 6 years ago by Tim Graham

Resolution: fixed
Status: newclosed

In [16258]:

Fixed #16051 - Changed a "file" reference in the tutorial to be an actual file rather than a module; thanks felix.morency for the suggestion.

comment:4 Changed 6 years ago by Tim Graham

In [16259]:

[1.3.X] Fixed #16051 - Changed a "file" reference in the tutorial to be an actual file rather than a module; thanks felix.morency for the suggestion.

Backport of r16258 from trunk.

comment:5 Changed 5 years ago by Jacob

milestone: 1.4

Milestone 1.4 deleted

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