Unclear documentation for default debug setting for DjangoTemplates engine

[lightstrike]

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:

• ​Template API
• ​Settings:TEMPLATE_DEBUG

In reality, the default is ​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 ​main settings page.

[Tim Graham]

The default value for DjangoTemplates is ​documented elsewhere from the places you linked. I think those other places are correct, but please clarify if you believe otherwise.

I'll propose this patch to address your last point:

docs/ref/settings.txt

@@ -2324 +2324 @@
 Default: ``{}`` (Empty dict)
 
 Extra parameters to pass to the template backend. Available parameters vary
-depending on the template backend.
+depending on the template backend. See
+:class:`~django.template.backends.django.DjangoTemplates` and
+:class:`~django.template.backends.jinja2.Jinja2` for the options of the
+built-in backends.
 
 .. setting:: TEMPLATE_CONTEXT_PROCESSORS
 

[Tim Graham <timograham@…>]

In f3e5a74:

Refs #25386 -- Added links to the OPTIONS of the built-in template backends.

[Tim Graham <timograham@…>]

In 2955dfd:

[1.8.x] Refs #25386 -- Added links to the OPTIONS of the built-in template backends.

Backport of f3e5a746469401a16939de0fc17fed584ced2118 from master

[Tim Graham]

Accepting on the basis that the "Configuration an Engine" section of the docs could use an upfront warning that if you're simply using DjangoTemplates, this isn't the documentation you're looking for (as described on the ​pull request).

[Tim Graham]

​PR

[Tim Graham <timograham@…>]

In 2634f60:

Fixed #25386 -- Warned about differences between Engine and DjangoTemplates.

[Tim Graham <timograham@…>]

In e7064df:

[1.8.x] Fixed #25386 -- Warned about differences between Engine and DjangoTemplates.

Backport of 2634f606d55b63511ab1c50c4fad2d52fbda1b19 from master