#14047 closed (fixed)
CommonMiddleware documentation tweak
| Reported by: | Owned by: | nobody | |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | middleware | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
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)
Change History (5)
by , 14 years ago
| Attachment: | middleware-doc.diff added |
|---|
comment:1 by , 14 years ago
comment:2 by , 14 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:3 by , 14 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
comment:4 by , 14 years ago
Note:
See TracTickets
for help on using tickets.
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