Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#18110 closed Cleanup/optimization (fixed)

Improve template cache tag documentation

Reported by: Julian Bez Owned by: nobody
Component: Documentation Version: master
Severity: Normal Keywords:
Cc: florian+django@… Triage Stage: Ready for checkin
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

For me it was not clear that the fragment name cannot be a variable. I just found out by wondering about errors and having a quick look into Django's code. It should be made more clear that the second argument will not be resolved even though all the others will be (even the cache time gets resolved).

"It takes at least two arguments: the cache timeout, in seconds, and the name to give the cache fragment. For example:"

should at least be something like

"It takes at least two arguments: the cache timeout, in seconds, and the name to give the cache fragment. The name will be taken as is, do not use a variable. For example:"

https://docs.djangoproject.com/en/dev/topics/cache/#template-fragment-caching

Change History (6)

comment:1 Changed 5 years ago by Jannis Leidel

Triage Stage: UnreviewedAccepted

comment:2 Changed 4 years ago by Florian Apolloner

Shouldn't we instead add a new cache tag to our future library to get this tag in line with the other tags (like we did with url and ssi)?

comment:3 Changed 4 years ago by Florian Apolloner

Cc: florian+django@… added

comment:4 Changed 4 years ago by anonymous

Triage Stage: AcceptedReady for checkin

There's an open pull request at https://github.com/django/django/pull/153

comment:5 Changed 4 years ago by Julian Bez <web-spy@…>

Resolution: fixed
Status: newclosed

In [3c0877938f5eafc822d32b6c4f85e5a46b873390]:

Fixed #18110 -- Improve template cache tag documentation

comment:6 Changed 4 years ago by Tim Graham <timograham@…>

In [84c3c9097d4a240ae2880ba272a207b96ddf7553]:

Merge pull request #153 from webjunkie/patch-1

Fixed #18110 -- Improve template cache tag documentation

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