Opened 7 years ago

Last modified 7 years ago

#29002 closed Bug

Documentation about cached template loader is inaccurate about DEBUG — at Version 1

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 (1)

comment:1 by oTree-org, 7 years ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top