[Django] #25727: cached_property's topic documentation does not link to reference
Django
------------------------------------------------+------------------------
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.
Django
Reporter: bmispelon | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by Tim Graham <timograham@…>):
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"e0de82c9b2c41c4c479d2245e7d5cd59638b5440" e0de82c]:
{{{
#!CommitTicketReference repository=""
revision="e0de82c9b2c41c4c479d2245e7d5cd59638b5440"
Fixed #25727 -- Added a doc link to cached_property.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25727#comment:1>
Django
Reporter: bmispelon | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"f10226232f31dc6d0a19db0b25a8e7aadea141da" f1022623]:
{{{
#!CommitTicketReference repository=""
revision="f10226232f31dc6d0a19db0b25a8e7aadea141da"
[1.9.x] Fixed #25727 -- Added a doc link to cached_property.
Backport of e0de82c9b2c41c4c479d2245e7d5cd59638b5440 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25727#comment:2>
Django
Reporter: bmispelon | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Comment (by Tim Graham <timograham@…>):
In [changeset:"e592574e6e3877eb9b5231e6630445e98a6e1841" e592574]:
{{{
#!CommitTicketReference repository=""
revision="e592574e6e3877eb9b5231e6630445e98a6e1841"
[1.8.x] Fixed #25727 -- Added a doc link to cached_property.
Backport of e0de82c9b2c41c4c479d2245e7d5cd59638b5440 from master
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25727#comment:3>