#29864: Add links from the cache framework topic guide to the low level API
-------------------------------------+-------------------------------------
Reporter: Thomas Güttler | Owner:
Type: | Prabakaran Kumaresshan
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 2.1
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Tim Graham):
I'm not sure. I guess I accepted the ticket prematurely. We could possibly
do something like this:
{{{ #!diff
diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt
index 2ffad67686..bf6cfc2ddf 100644
--- a/docs/topics/cache.txt
+++ b/docs/topics/cache.txt
@@ -788,9 +788,16 @@ Accessing the cache
Basic usage
-----------
-The basic interface is ``set(key, value, timeout)`` and ``get(key)``::
+.. currentmodule:: django.core.caches
+
+The basic interface is:
+
+.. method:: cache.set(key, value, timeout)
>>> cache.set('my_key', 'hello, world!', 30)
+
+.. method:: cache.get(key)
+
>>> cache.get('my_key')
'hello, world!'
}}}
or create a separate reference document if it's useful. Maybe the ticket
reporter can elaborate as "the first cache.get() and cache.set()
occurrences" seem to be in the "low-level cache API" section.
--
Ticket URL: <https://code.djangoproject.com/ticket/29864#comment:9>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/065.47ac450cbbeac88d7d0d390feee69177%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
