Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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:  closed
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:  fixed
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  1|UI/UX:  0
-+-

Comment (by Tim Graham ):

 In [changeset:"24a85f44c2726bbb6557731af70f6c52302ddac3" 24a85f4]:
 {{{
 #!CommitTicketReference repository=""
 revision="24a85f44c2726bbb6557731af70f6c52302ddac3"
 [2.1.x] Fixed #29864 -- Added link targets for low-level cache API.

 Backport of 8250538bfc9792c87cd42c27fa778f12e14350cb from master.
 }}}

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.edaef45388ec30b0a76c538990b88a41%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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:  closed
Component:  Documentation|  Version:  master
 Severity:  Normal   |   Resolution:  fixed
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  1|UI/UX:  0
-+-
Changes (by Tim Graham ):

 * status:  assigned => closed
 * resolution:   => fixed


Comment:

 In [changeset:"8250538bfc9792c87cd42c27fa778f12e14350cb" 8250538b]:
 {{{
 #!CommitTicketReference repository=""
 revision="8250538bfc9792c87cd42c27fa778f12e14350cb"
 Fixed #29864 -- Added link targets for low-level cache API.
 }}}

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.f4eefaa5be2c4b732d4b28e2b3e9f0da%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  1|UI/UX:  0
-+-

Comment (by Prabakaran Kumaresshan):

 I have updated the [https://github.com/django/django/pull/10567 PR] with
 method references

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.36df8b7d93bde33193c14f5d1d6e0900%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  1|UI/UX:  0
-+-

Comment (by Prabakaran Kumaresshan):

 Replying to [comment:13 Tim Graham]:
 > My patch which was submitted verbatim in the PR isn't complete. There
 are many more cache methods that should be documented in a similar
 fashion.

 Ok sure let me check

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.f57ec518723819779eb9af95d83a6eef%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  1
Easy pickings:  1|UI/UX:  0
-+-
Changes (by Tim Graham):

 * needs_better_patch:  0 => 1


Comment:

 My patch which was submitted verbatim in the PR isn't complete. There are
 many more cache methods that should be documented in a similar fashion.

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.f1263476dd158d825397d7eb7ca3663a%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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:  master
 Severity:  Normal   |   Resolution:
 Keywords:   | Triage Stage:  Accepted
Has patch:  1|  Needs documentation:  0
  Needs tests:  0|  Patch needs improvement:  0
Easy pickings:  1|UI/UX:  0
-+-
Changes (by Prabakaran Kumaresshan):

 * has_patch:  0 => 1
 * version:  2.1 => master


Comment:

 [https://github.com/django/django/pull/10567 PR]

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.27a02b0053a99bc461a0806e20c4058a%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
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.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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 Prabakaran Kumaresshan):

 That might clarify, lets hear from the reporter.

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.a6ccca0614b41603e455ba3de1fd9938%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
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.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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 Prabakaran Kumaresshan):

 I'm just wondering where does the low level document for get and set
 methods are available, there isn't any document on cache other than the
 topic on cache. Or is it the documentation of respective backends ?

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.1560caad8e516c4af90ba041829438eb%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#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
-+-
Changes (by Prabakaran Kumaresshan):

 * owner:  (none) => Prabakaran Kumaresshan
 * status:  new => assigned


-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.bf32c89463b642272ff8c9be05fa1853%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#29864: Add links from the cache framework topic guide to the low level API
--+
 Reporter:  Thomas Güttler|Owner:  (none)
 Type:  Cleanup/optimization  |   Status:  new
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
--+

Old description:

> Please make at least the first cache.get() and cache.set() occurrences a
> hyperlink to the low-level API docs.
>
> https://docs.djangoproject.com/en/2.1/topics/cache/
>

> My use question on mind: Is there a way to get a default-value from the
> cache like the get() method can be used to return a default-value from a
> dict.

New description:

 Please make at least the first `cache.get()` and `cache.set()` occurrences
 a hyperlink to the low-level API docs.

 https://docs.djangoproject.com/en/dev/topics/cache/

 My use question on mind: Is there a way to get a default-value from the
 cache like the get() method can be used to return a default-value from a
 dict.

--

Comment (by Tim Graham):

 It would be nice to link the first instance of all methods.

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.983f13f2e1c3a2d92f959adfad52a0b3%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#29864: Add links from the cache framework topic guide to the low level API
--+
 Reporter:  Thomas Güttler|Owner:  (none)
 Type:  Cleanup/optimization  |   Status:  new
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
--+
Changes (by Gastror):

 * owner:  Gastror => (none)
 * status:  assigned => new


Comment:

 No other methods have any links, so why should they be added for these
 two?

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.1b7c8251a4626af7b5fb42e50e592118%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#29864: Add links from the cache framework topic guide to the low level API
--+
 Reporter:  Thomas Güttler|Owner:  Gastror
 Type:  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
--+
Changes (by Gastror):

 * status:  new => assigned
 * owner:  (none) => Gastror


-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.ee0c132b98dc461dc40a422b763d4459%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#29864: Add links from the cache framework topic guide to the low level API
--+
 Reporter:  Thomas Güttler|Owner:  (none)
 Type:  Cleanup/optimization  |   Status:  new
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
--+
Changes (by Rand01ph):

 * owner:  Rand01ph => (none)
 * status:  assigned => new


-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.55e4f651304c65719379f19ca96675f6%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API

[Django]

#29864: Add links from the cache framework topic guide to the low level API
--+
 Reporter:  Thomas Güttler|Owner:  Rand01ph
 Type:  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
--+
Changes (by Rand01ph):

 * owner:  nobody => Rand01ph
 * status:  new => assigned


-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.0ab220321ebd677b3d00f5ea38660a92%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Re: [Django] #29864: Add links from the cache framework topic guide to the low level API (was: Hyperlnks from general cache framework docs page to low level API)

[Django]

#29864: Add links from the cache framework topic guide to the low level API
--+
 Reporter:  Thomas Güttler|Owner:  nobody
 Type:  Cleanup/optimization  |   Status:  new
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
--+
Changes (by Tim Graham):

 * type:  Uncategorized => Cleanup/optimization
 * easy:  0 => 1
 * stage:  Unreviewed => Accepted


Comment:

 That looks fine. We don't want to add redundant links everywhere because
 each change requires translators to redo work.

-- 
Ticket URL: 
Django 
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 django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-updates/065.689d5d4c18e1a906f4e9fe7551089d97%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.