Opened 16 years ago

Closed 13 years ago

Last modified 13 years ago

#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)

http-view-decorators.diff (3.1 KB ) - added by Adam Vandenberg 14 years ago.
document-view-decorators.diff (3.2 KB ) - added by Adam Vandenberg 13 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 13 years ago.
Added back-link and always use parens.

Download all attachments as: .zip

Change History (11)

comment:1 by Simon G <dev@…>, 16 years ago

Triage Stage: UnreviewedAccepted

comment:2 by Nick Efford, 16 years ago

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

by Adam Vandenberg, 14 years ago

Attachment: http-view-decorators.diff added

comment:3 by Adam Vandenberg, 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 Adam Vandenberg, 13 years ago

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.

by Adam Vandenberg, 13 years ago

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

comment:5 by Adam Vandenberg, 13 years ago

Patch needs improvement: unset

by Adam Vandenberg, 13 years ago

Added back-link and always use parens.

comment:6 by Adam Vandenberg, 13 years ago

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

comment:7 by Tim Graham, 13 years ago

Resolution: fixed
Status: newclosed

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

comment:8 by Tim Graham, 13 years ago

(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