Code

Opened 5 years ago

Closed 5 years ago

Last modified 3 years ago

#9464 closed (fixed)

404 section of tutorial part 3 is unclear, and not complete

Reported by: Grahack Owned by: jacob
Component: Documentation Version:
Severity: Keywords: tutorial, error pages
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

In this section about 404 of the tutorial part 3, I find this list unclear.

  • The 404 view is also called if Django doesn't find a match after checking every regular expression in the URLconf.
  • If you don't define your own 404 view -- and simply use the default, which is recommended -- you still have one obligation: To create a 404.html template in the root of your template directory. The default 404 view will use that template for all 404 errors.
  • If DEBUG is set to True (in your settings module) then your 404 view will never be used, and the traceback will be displayed instead.

I'd prefer starting with the last item. Also, when DEBUG is set to False and if you didn't create a 404.html file, you get an error 500. I think this should be explained here.

I'd suggest:

  • If DEBUG is set to True (in your settings module) then your 404 view will never be used, and the traceback will be displayed instead.
  • The 404 view is also called if Django doesn't find a match after checking every regular expression in the URLconf.
  • If you don't define your own 404 view -- and simply use the default, which is recommended -- you still have one obligation: To create a 404.html template in the root of your template directory. The default 404 view will use that template for all 404 errors.
  • If DEBUG is set to False (in your settings module) and if you didn't create a 404.html file, an Http500 is raised.

BTW I don't like this 500 feature but this is another story. I'd prefer the server to just send a 404 Not Found.

Attachments (1)

tutorial03.reorder-404-list.patch (512 bytes) - added by Grahack 5 years ago.
patch against tutoria03.txt to clear the notes about 404

Download all attachments as: .zip

Change History (6)

Changed 5 years ago by Grahack

patch against tutoria03.txt to clear the notes about 404

comment:1 Changed 5 years ago by Grahack

  • Has patch set
  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

comment:2 Changed 5 years ago by jacob

  • milestone set to 1.1
  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 5 years ago by jacob

  • Owner changed from nobody to jacob
  • Status changed from new to assigned

comment:4 Changed 5 years ago by jacob

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

(In [10371]) Fixed a whole bunch of small docs typos, errors, and ommissions.

Fixes #8358, #8396, #8724, #9043, #9128, #9247, #9267, #9267, #9375, #9409, #9414, #9416, #9446, #9454, #9464, #9503, #9518, #9533, #9657, #9658, #9683, #9733, #9771, #9835, #9836, #9837, #9897, #9906, #9912, #9945, #9986, #9992, #10055, #10084, #10091, #10145, #10245, #10257, #10309, #10358, #10359, #10424, #10426, #10508, #10531, #10551, #10635, #10637, #10656, #10658, #10690, #10699, #19528.

Thanks to all the respective authors of those tickets.

comment:18 Changed 3 years ago by jacob

  • milestone 1.1 deleted

Milestone 1.1 deleted

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.