#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 Thomas Güttler):
I think there are two issues, if you look at in detail.
First: It would be really useful if there is a URL for every public method
of django. In this case cache.get() and cache.set(). This makes it much
easier
if you write answers or questions at (for example) stackoverflow. You can
write then: "you should use method cache.get()" and make "cache.get()" a
hyperlink to the docs.
Tim Graham already created a solution for this (see above). Thank you Tim.
Second: Hyperlinks inside the docs are useful. They do not need to
everywhere. I think it is a pragmatic solution if the first usage of a
method name in a chapter is a hyperlink.
--
Ticket URL: <https://code.djangoproject.com/ticket/29864#comment:11>
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.2bcb9c84822c70b2885e7313b2a60329%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
