p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
This commit is contained in:
Adrian Holovaty 2010-01-10 18:40:24 +00:00
parent 5ce16c7e27
commit 7789e9c006
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/topics/cache.txt
View File

@ -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``::