Opened 8 years ago

Closed 8 years ago

Last modified 8 years ago

#25727 closed Cleanup/optimization (fixed)

cached_property's topic documentation does not link to reference

Reported by: Baptiste Mispelon Owned by: nobody
Component: Documentation Version: 1.8
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

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.

Change History (3)

comment:1 by Tim Graham <timograham@…>, 8 years ago

Resolution: fixed
Status: newclosed

In e0de82c:

Fixed #25727 -- Added a doc link to cached_property.

comment:2 by Tim Graham <timograham@…>, 8 years ago

In f1022623:

[1.9.x] Fixed #25727 -- Added a doc link to cached_property.

Backport of e0de82c9b2c41c4c479d2245e7d5cd59638b5440 from master

comment:3 by Tim Graham <timograham@…>, 8 years ago

In e592574:

[1.8.x] Fixed #25727 -- Added a doc link to cached_property.

Backport of e0de82c9b2c41c4c479d2245e7d5cd59638b5440 from master

Note: See TracTickets for help on using tickets.
Back to Top