[Changeset] r12183 - django/trunk/docs/topics

[nor...@djangoproject.com]

Author: adrian
Date: 2010-01-10 12:40:24 -0600 (Sun, 10 Jan 2010)
New Revision: 12183

Modified:
django/trunk/docs/topics/cache.txt
Log:
Fixed #12195 -- Clarified cache documentation to rename 'timeout_seconds' to 'timeout'. Thanks, galund and timo

Modified: django/trunk/docs/topics/cache.txt
===================================================================
--- django/trunk/docs/topics/cache.txt 2010-01-10 18:38:00 UTC (rev 12182)
+++ django/trunk/docs/topics/cache.txt 2010-01-10 18:40:24 UTC (rev 12183)
@@ -470,14 +470,15 @@

>>> from django.core.cache import cache

-The basic interface is ``set(key, value, timeout_seconds)`` and ``get(key)``::
+The basic interface is ``set(key, value, timeout)`` and ``get(key)``::

>>> cache.set('my_key', 'hello, world!', 30)
>>> cache.get('my_key')
'hello, world!'

-The ``timeout_seconds`` argument is optional and defaults to the ``timeout``
-argument in the ``CACHE_BACKEND`` setting (explained above).
+The ``timeout`` argument is optional and defaults to the ``timeout``
+argument in the ``CACHE_BACKEND`` setting (explained above). It's the number of
+seconds the value should be stored in the cache.

If the object doesn't exist in the cache, ``cache.get()`` returns ``None``::