#25386: Unclear documentation for default debug setting for DjangoTemplates
engine
-------------------------------------+-------------------------------------
Reporter: lightstrike | Owner:
Type: | lightstrike
Cleanup/optimization | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: template, template | Triage Stage:
engine | Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by timgraham):
* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0
Comment:
The default value for `DjangoTemplates` is
[https://docs.djangoproject.com/en/dev/topics/templates/#django.template.backends.django.DjangoTemplates
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:
{{{#!diff
diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt
index f4e5c37..d2582c6 100644
--- a/docs/ref/settings.txt
+++ b/docs/ref/settings.txt
@@ -2324,7 +2324,10 @@ OPTIONS
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
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/25386#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/069.ff1045930afd6b3f76ea44794cf14b88%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
