#6181 closed (fixed)
Document `django.views.decorators.http`
| Reported by: | James Bennett | Owned by: | Adam Vandenberg |
|---|---|---|---|
| Component: | Documentation | Version: | dev |
| Severity: | Keywords: | ||
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description
This module contains several useful decorators, but as far as I can tell there isn't official documentation for them.
Attachments (3)
Change History (11)
comment:1 by , 17 years ago
| Triage Stage: | Unreviewed → Accepted |
|---|
comment:2 by , 17 years ago
by , 14 years ago
| Attachment: | http-view-decorators.diff added |
|---|
comment:3 by , 14 years ago
| Has patch: | set |
|---|---|
| Patch needs improvement: | set |
Attached a rough cut at some docs, taken mostly from the docstrings in the module itself. Let me know if I should do something different, etc., or expand the scope of this doc to other modules with decorators.
comment:4 by , 14 years ago
| Owner: | changed from to |
|---|
Some (but not all) view decorators are documented scattered around other documents; going to redo this patch to have a ref page that documents the undocumented ones and links to topic pages for ones that are already documented in detail.
by , 14 years ago
| Attachment: | document-view-decorators.diff added |
|---|
Add docs missing for a few view decorators, and link to existing docs for already documented ones.
comment:5 by , 14 years ago
| Patch needs improvement: | unset |
|---|
by , 14 years ago
| Attachment: | document-view-decorators2.diff added |
|---|
Added back-link and always use parens.
comment:6 by , 14 years ago
Ready for committers & other interested parties to give me feedback here, thanks.
comment:7 by , 14 years ago
| Resolution: | → fixed |
|---|---|
| Status: | new → closed |
This could be generalized to a "Decorating a View" page in the docs, including information on other decorators such as gzip.