Ticket #5484: 5484.diff

docs/templates_python.txt

@@ -555 +555 @@
 Django uses the template loaders in order according to the ``TEMPLATE_LOADERS``
 setting. It uses each loader until a loader finds a match.
 
+The ``render_to_string()`` and ``render_to_response()`` shortcuts
+=================================================================
+
+To cut down on the repetitive nature of loading and rendering
+templates, Django provides two shortcut functions which largely
+automate the process: ``render_to_string()`` in
+``django.template.loader`` and ``render_to_response()`` in
+``django.shortcuts``.
+
+``django.template.loader.render_to_string()``
+---------------------------------------------
+
+Renders a template and returns the resulting string.
+
+**Required arguments:**
+
+    template_name
+        The name of the template to render. Can also be passed as the
+        first positional argument.
+
+**Optional arguments:**
+
+    dictionary
+        A dictionary to be used as variables and values for the
+        template's context. Can also be passed as the second
+        positional argument.
+
+    context_instance
+        An instance of ``Context`` or a subclass (e.g., an instance of
+        ``RequestContext``) to use as the template's context. Can also
+        be passed as the third positional argument.
+
+``django.shortcuts.render_to_response()``
+-----------------------------------------
+
+Like ``render_to_string``, but returns an ``HttpResponse`` object with
+the rendered template as its contents.
+
+**Required arguments**
+
+    template_name
+        The name of the template to render. Can also be passed as the
+        first positional argument.
+
+**Optional arguments**
+
+    dictionary
+        A dictionary to be used as variables and values for the
+        template's context. Can also be passed as the second
+        positional argument.
+
+    context_instance
+        An instance of ``Context`` or a subclass (e.g., an instance of
+        ``RequestContext``) to use as the template's context. Can also
+        be passed as the third positional argument.
+
+    mimetype
+        The HTTP Content-Type to use for the ``HttpResponse``. Must be
+        passed as a keyword argument.
+
 Extending the template system
 =============================