Skip to content

Commit

Permalink
[1.2.X] Fixed #14737 -- Moved the docstring comment for the cache_pag…
Browse files Browse the repository at this point in the history
…e decorator so it gets picked up as a docstring. Thanks to adamv for the report and patch.

Backport of r14798 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@14802 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
freakboy3742 committed Dec 4, 2010
1 parent 821b7f3 commit 5a792ec
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions django/views/decorators/cache.py
@@ -1,16 +1,3 @@
"""
Decorator for views that tries getting the page from the cache and
populates the cache if the page isn't in the cache yet.
The cache is keyed by the URL and some data from the headers. Additionally
there is the key prefix that is used to distinguish different cache areas
in a multi-site setup. You could use the sites.get_current().domain, for
example, as that is unique across a Django project.
Additionally, all headers from the response's Vary header will be taken into
account on caching -- just like the middleware does.
"""

try:
from functools import wraps
except ImportError:
Expand All @@ -22,6 +9,19 @@


def cache_page(*args, **kwargs):
"""
Decorator for views that tries getting the page from the cache and
populates the cache if the page isn't in the cache yet.
The cache is keyed by the URL and some data from the headers.
Additionally there is the key prefix that is used to distinguish different
cache areas in a multi-site setup. You could use the
sites.get_current().domain, for example, as that is unique across a Django
project.
Additionally, all headers from the response's Vary header will be taken
into account on caching -- just like the middleware does.
"""
# We need backwards compatibility with code which spells it this way:
# def my_view(): pass
# my_view = cache_page(my_view, 123)
Expand Down

0 comments on commit 5a792ec

Please sign in to comment.