Opened 13 years ago

Closed 10 years ago

Last modified 10 years ago

#6181 closed (fixed)

Document `django.views.decorators.http`

Reported by: James Bennett Owned by: Adam Vandenberg
Component: Documentation Version: master
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)

http-view-decorators.diff (3.1 KB) - added by Adam Vandenberg 10 years ago.
document-view-decorators.diff (3.2 KB) - added by Adam Vandenberg 10 years ago.
Add docs missing for a few view decorators, and link to existing docs for already documented ones.
document-view-decorators2.diff (3.8 KB) - added by Adam Vandenberg 10 years ago.
Added back-link and always use parens.

Download all attachments as: .zip

Change History (11)

comment:1 Changed 13 years ago by Simon G <dev@…>

Triage Stage: UnreviewedAccepted

comment:2 Changed 13 years ago by Nick Efford

This could be generalized to a "Decorating a View" page in the docs, including information on other decorators such as gzip.

Changed 10 years ago by Adam Vandenberg

Attachment: http-view-decorators.diff added

comment:3 Changed 10 years ago by Adam Vandenberg

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 Changed 10 years ago by Adam Vandenberg

Owner: changed from James Bennett to Adam Vandenberg

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.

Changed 10 years ago by Adam Vandenberg

Add docs missing for a few view decorators, and link to existing docs for already documented ones.

comment:5 Changed 10 years ago by Adam Vandenberg

Patch needs improvement: unset

Changed 10 years ago by Adam Vandenberg

Added back-link and always use parens.

comment:6 Changed 10 years ago by Adam Vandenberg

Ready for committers & other interested parties to give me feedback here, thanks.

comment:7 Changed 10 years ago by Tim Graham

Resolution: fixed
Status: newclosed

(In [15064]) Fixed #6181 - Document django.views.decorators.http - thanks adamv for the patch.

comment:8 Changed 10 years ago by Tim Graham

(In [15065]) [1.2.X] Fixed #6181 - Document django.views.decorators.http - thanks adamv for the patch.

Backport of r15064 from trunk.

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