#25386: Unclear documentation for default debug setting for DjangoTemplates
engine
-------------------------------------+-------------------------------------
Reporter: lightstrike | Owner: lightstrike
Type: | Status: new
Cleanup/optimization |
Component: Documentation | Version: 1.8
Severity: Normal | Keywords: template, template
| engine
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
In 1.8, the TEMPLATE_DEBUG setting is deprecated in favor of setting
'debug' as part of the OPTIONS sub-setting in a backend in TEMPLATES.
In a couple parts of the documentation, it is stated that the default
'debug' setting for DjangoTemplates engine is False:
* [https://docs.djangoproject.com/en/dev/ref/templates/api/#configuring-
an-engine Template API]
* [https://docs.djangoproject.com/en/1.8/ref/settings/#template-debug
Settings:TEMPLATE_DEBUG]
In reality, the default is
[https://github.com/django/django/blob/aaacaeb0963c406c4fe6f68c6ae51f4a65878250/django/template/backends/django.py#L28
apparently set according to settings.DEBUG].
I suggest clarifying the documentation to state that the default debug
setting is equal to settings.DEBUG (which is True by default). It would be
additionally helpful to link to the possible options one can set in a
template engine on the
[https://docs.djangoproject.com/en/1.8/ref/settings/#std:setting-
TEMPLATES-OPTIONS main settings page].
--
Ticket URL: <https://code.djangoproject.com/ticket/25386>
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/054.ab4b9c2154a6917ac342698170c4d2f0%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
