Opened 8 years ago

Closed 5 years ago

Last modified 5 years ago

#6181 closed (fixed)

Document `django.views.decorators.http`

Reported by: ubernostrum Owned by: adamv
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: UI/UX:

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 adamv 5 years ago.
document-view-decorators.diff (3.2 KB) - added by adamv 5 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 adamv 5 years ago.
Added back-link and always use parens.

Download all attachments as: .zip

Change History (11)

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

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 8 years ago by nickefford

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

Changed 5 years ago by adamv

comment:3 Changed 5 years ago by adamv

  • 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 5 years ago by adamv

  • Owner changed from ubernostrum to adamv

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 5 years ago by adamv

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

comment:5 Changed 5 years ago by adamv

  • Patch needs improvement unset

Changed 5 years ago by adamv

Added back-link and always use parens.

comment:6 Changed 5 years ago by adamv

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

comment:7 Changed 5 years ago by timo

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

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

comment:8 Changed 5 years ago by timo

(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