summaryrefslogtreecommitdiff
path: root/docs/ref/templates
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-09-23 14:48:50 -0400
committerTim Graham <timograham@gmail.com>2015-09-23 19:19:03 -0400
commite7064df44f38c60a4e2aa1dfc41d544b1a77ca65 (patch)
tree51613ea29a33092fa9e1f907f43af34c6b961680 /docs/ref/templates
parent67896c85610744318d2ba9c2d5570568889ac3c3 (diff)
[1.8.x] Fixed #25386 -- Warned about differences between Engine and DjangoTemplates.
Backport of 2634f606d55b63511ab1c50c4fad2d52fbda1b19 from master
Diffstat (limited to 'docs/ref/templates')
-rw-r--r--docs/ref/templates/api.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/ref/templates/api.txt b/docs/ref/templates/api.txt
index ca27114bcb..1a739acfa1 100644
--- a/docs/ref/templates/api.txt
+++ b/docs/ref/templates/api.txt
@@ -41,6 +41,13 @@ lower level APIs:
Configuring an engine
=====================
+If you are simply using the
+:class:`~django.template.backends.django.DjangoTemplates` backend, this
+probably isn't the documentation you're looking for. An instance of the
+``Engine`` class described below is accessible using the ``engine`` attribute
+of that backend and any attribute defaults mentioned below are overridden by
+what's passed by :class:`~django.template.backends.django.DjangoTemplates`.
+
.. class:: Engine(dirs=None, app_dirs=False, allowed_include_roots=None, context_processors=None, debug=False, loaders=None, string_if_invalid='', file_charset='utf-8')
.. versionadded:: 1.8