Opened 11 months ago

Closed 11 months ago

Last modified 11 months ago

#29002 closed Bug (fixed)

Documentation about cached template loader is inaccurate about DEBUG

Reported by: oTree-org Owned by: nobody
Component: Documentation Version: 2.0
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by oTree-org)

The documentation here: https://docs.djangoproject.com/en/2.0/ref/templates/api/#django.template.loaders.cached.Loader

It says about the cached template loader:

This loader is automatically enabled if DEBUG is False and OPTIONS['loaders'] isn’t specified.

Actually, it's not based on DEBUG per se, but rather the template engine's 'debug' option, which is acknowledged correctly elsewhere in the docs.

So, I would correct that text to:

This loader is automatically enabled if OPTIONS['loaders'] isn’t specified and the OPTIONS['debug'] is False (if not set, this option defaults to the value of DEBUG)

Change History (6)

comment:1 Changed 11 months ago by oTree-org

Description: modified (diff)

comment:2 Changed 11 months ago by Tim Graham

Has patch: set
Triage Stage: UnreviewedAccepted

comment:3 Changed 11 months ago by Carlton Gibson

Triage Stage: AcceptedReady for checkin

comment:4 Changed 11 months ago by GitHub <noreply@…>

Resolution: fixed
Status: newclosed

In 7c00f9f:

Fixed #29002 -- Corrected cached template loader docs about when it's automatically enabled.

Thanks oTree-org for the suggestion.

comment:5 Changed 11 months ago by Tim Graham <timograham@…>

In 3d144787:

[2.0.x] Fixed #29002 -- Corrected cached template loader docs about when it's automatically enabled.

Thanks oTree-org for the suggestion.

Backport of 7c00f9fb1cc47e1c993f7728e2b592a1be29dd40 from master

comment:6 Changed 11 months ago by Tim Graham <timograham@…>

In bb39e4b5:

[1.11.x] Fixed #29002 -- Corrected cached template loader docs about when it's automatically enabled.

Thanks oTree-org for the suggestion.

Backport of 7c00f9fb1cc47e1c993f7728e2b592a1be29dd40 from master

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