#29002: Documentation about cached template loader is inaccurate about DEBUG
-------------------------------+--------------------------------------
Reporter: oTree-org | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: 2.0
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Description changed by oTree-org:
Old description:
> 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 template engine's debug option is False (if not set,
> this option defaults to the value of DEBUG)
> }}}
New description:
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)
}}}
--
--
Ticket URL: <https://code.djangoproject.com/ticket/29002#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.d08258399153339ca9379536a4403096%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
