summaryrefslogtreecommitdiff
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:16:16 -0400
commit2634f606d55b63511ab1c50c4fad2d52fbda1b19 (patch)
tree7981bcfe46c37669397279ef8e48e4a0ac4845b2
parent25cccca0a286585b9896546d57559e41b4e2ca16 (diff)
Fixed #25386 -- Warned about differences between Engine and DjangoTemplates.
-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 9cd4fd791c..a8311d30fd 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', libraries=None, builtins=None)
.. versionadded:: 1.8