summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Güttler <hv@tbz-pariv.de>2015-02-11 16:00:12 +0100
committerTim Graham <timograham@gmail.com>2015-02-12 10:32:56 -0500
commit6b8c8d7e18bf46def3d6c9be3f9b77f52c5d85b2 (patch)
tree140c32097cc014da6759b28cfa952ddfb7f5d49e
parent8d1816db87e9e700d9bd5336ac25686fdf30c789 (diff)
[1.8.x] Clarified timeout=0 in cache docs.
Backport of e519ee1d352e0e36fcb8edc9d33ec2845f663d3a from master
-rw-r--r--docs/topics/cache.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt
index d62b9519ee..a9e7f2585e 100644
--- a/docs/topics/cache.txt
+++ b/docs/topics/cache.txt
@@ -366,14 +366,14 @@ Each cache backend can be given additional arguments to control caching
behavior. These arguments are provided as additional keys in the
:setting:`CACHES` setting. Valid arguments are as follows:
-
* :setting:`TIMEOUT <CACHES-TIMEOUT>`: The default timeout, in
seconds, to use for the cache. This argument defaults to ``300`` seconds (5 minutes).
.. versionadded:: 1.7
You can set ``TIMEOUT`` to ``None`` so that, by default, cache keys never
- expire.
+ expire. A value of ``0`` causes keys to immediately expire (effectively
+ "don't cache").
* :setting:`OPTIONS <CACHES-OPTIONS>`: Any options that should be
passed to the cache backend. The list of valid options will vary
@@ -774,7 +774,8 @@ The basic interface is ``set(key, value, timeout)`` and ``get(key)``::
The ``timeout`` argument is optional and defaults to the ``timeout`` argument
of the appropriate backend in the :setting:`CACHES` setting (explained above).
It's the number of seconds the value should be stored in the cache. Passing in
-``None`` for ``timeout`` will cache the value forever.
+``None`` for ``timeout`` will cache the value forever. A ``timeout`` of ``0``
+won't cache the value.
If the object doesn't exist in the cache, ``cache.get()`` returns ``None``::