Fixed #12195 -- Clarified cache documentation to rename 'timeout_seconds' to 'timeout'. Thanks, galund and timo

git-svn-id: http://code.djangoproject.com/svn/django/trunk@12183 bcc190cf-cafb-0310-a4f2-bffc1f526a37

1 files changed, 4 insertions, 3 deletions

diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt
index 6b3af2a541..f7b1fd5b35 100644
--- a/docs/topics/cache.txt
+++ b/docs/topics/cache.txt
@@ -470,14 +470,15 @@ automatically created from the ``CACHE_BACKEND`` setting::
 
     >>> 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``::