Django

Code

Ticket #9464 (closed: fixed)

Opened 1 year ago

Last modified 1 year ago

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

Reported by: Grahack Assigned to: jacob
Milestone: 1.1 Component: Documentation
Version: Keywords: tutorial, error pages
Cc: Triage Stage: Accepted
Has patch: 1 Needs documentation: 0
Needs tests: 0 Patch needs improvement: 0

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

tutorial03.reorder-404-list.patch (0.5 kB) - added by Grahack on 10/29/08 15:41:43.
patch against tutoria03.txt to clear the notes about 404

Change History

10/29/08 15:41:43 changed by Grahack

  • attachment tutorial03.reorder-404-list.patch added.

patch against tutoria03.txt to clear the notes about 404

10/29/08 15:45:56 changed by Grahack

  • needs_better_patch changed.
  • has_patch set to 1.
  • needs_tests changed.
  • needs_docs changed.

02/26/09 14:11:17 changed by jacob

  • stage changed from Unreviewed to Accepted.
  • milestone set to 1.1.

04/02/09 13:42:20 changed by jacob

  • owner changed from nobody to jacob.
  • status changed from new to assigned.

04/03/09 13:30:55 changed by jacob

  • status changed from assigned to closed.
  • resolution set to fixed.

(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.

Add/Change #9464 (404 section of tutorial part 3 is unclear, and not complete)




Change Properties
Action