#25727: cached_property's topic documentation does not link to reference
------------------------------------------------+------------------------
               Reporter:  bmispelon             |          Owner:  nobody
                   Type:  Cleanup/optimization  |         Status:  new
              Component:  Documentation         |        Version:  1.8
               Severity:  Normal                |       Keywords:
           Triage Stage:  Unreviewed            |      Has patch:  0
    Needs documentation:  0                     |    Needs tests:  0
Patch needs improvement:  0                     |  Easy pickings:  1
                  UI/UX:  0                     |
------------------------------------------------+------------------------
 The paragraph at https://docs.djangoproject.com/en/dev/topics/performance
 /#cached-property does not link to the reference documentation at
 
https://docs.djangoproject.com/en/1.8/ref/utils/#django.utils.functional.cached_property.

 In particular, it does not mention the import path.

 This is especially a problem because the performance page appears before
 the reference page in a search for `cached_property`.

 I think having the text `@cached_property` in the sentence `Using the
 @cached_property decorator saves the value returned [...]` be a link
 should be enough.

--
Ticket URL: <https://code.djangoproject.com/ticket/25727>
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/052.1c435f14f2488740f09dfbb647a267ce%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to