Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#14047 closed (fixed)

CommonMiddleware documentation tweak

Reported by: Leon Matthews <python@…> Owned by: nobody
Component: Documentation Version: master
Severity: Keywords: middleware
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

I've just started using Django (awesome work, btw! :-). I was reading through the source code for the CommonMiddleware class and noticed a discrepancy between the documentation and the code.

I have attached a patch which is hopefully both a fix, and a clear explanation of the problem...

Attachments (1)

middleware-doc.diff (1.3 KB) - added by Leon Matthews <python@…> 5 years ago.

Download all attachments as: .zip

Change History (5)

Changed 5 years ago by Leon Matthews <python@…>

comment:1 Changed 5 years ago by leonov

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

Patch has had no attention, so I probably should have written a better summary... Here goes:

The docstring describing CommonMiddleware.process_response() doesn't match what the method is actually doing -- presumably it's a historical artifact. Contrary to the docstring, no flatpage checking is done in process_response(). However broken link emails may be sent, something not mentioned in the docstring at all.

The attached patch fixes the methods docstring, as well as adding a note about the conditional sending of broken link emails in docs/ref/middleware.txt

comment:2 Changed 4 years ago by gabrielhurley

  • Triage Stage changed from Unreviewed to Accepted

comment:3 Changed 4 years ago by gabrielhurley

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

(In [14352]) Fixed #14047 -- Updated the CommonMiddleware docs to include sending broken link email notifications. Thanks to Leon Matthews for the report and patch.

comment:4 Changed 4 years ago by gabrielhurley

(In [14353]) [1.2.X] Fixed #14047 -- Updated the CommonMiddleware docs to include sending broken link email notifications. Thanks to Leon Matthews for the report and patch.

Backport of [14532] from trunk.

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