never_cache decorator is not documented

[Ville Säävuori <ville@…>]

While searching docs for how to disable caching, I found that never_cache decorator in django.views.decorators.cache is not documented. It is, however, documented in changeset #2602.

[Simon G. <dev@…>]

Want to write it up?

[Ville Säävuori <ville@…>]

I was trying to say that the decoratos _has already been documented_ in changeset 2602 (the link above goes to bug 2602, not changeset) but for some reason it's not there anymore.

A quick copypaste and reformatting resulted in:

If you want to use headers to disable caching altogether, ``django.views.decorators.never_cache`` is a view decorator that adds
headers to ensure the response won't be cached by browsers or other caches. Example::

    from django.views.decorators.cache import never_cache
    @never_cache
    def myview(request):
        ...

Above should go under the heading "Controlling cache: Using other headers".

[Fernando Gutierrez]

Patch for documentation.

[Ville Säävuori]

I think the included hasn't got proper line length. It shoud be easy to correct after applying the patch, though.

[Fernando Gutierrez]

Respect the line width.

[Fernando Gutierrez]

I have attached a new diff that respects the line length.

[Adrian Holovaty]

(In [6308]) Fixed #5284 -- Documented never_cache decorator. Thanks, xbito