Ticket #26410: 26410.diff

docs/ref/templates/api.txt

@@ -1093 +1093 @@
 
         If the template is instantiated directly rather than through a
         template loader, this is ``None``.
+
+The ``render_to_string`` shortcut
+===================================
+
+.. function:: loader.render_to_string(template_name, context=None, context_instance=None)
+
+To cut down on the repetitive nature of loading and rendering
+templates, Django provides a shortcut function which largely
+automates the process: ``render_to_string()`` in
+:mod:`django.template.loader`, which loads a template, renders it and
+returns the resulting string::
+
+    from django.template.loader import render_to_string
+    rendered = render_to_string('my_template.html', {'foo': 'bar'})
+
+The ``render_to_string`` shortcut takes one required argument --
+``template_name``, which should be the name of the template to load
+and render (or a list of template names, in which case Django will use
+the first template in the list that exists) -- and two optional arguments:
+
+``context``
+    A dictionary to be used as variables and values for the
+    template's context. This should be passed as the second
+    positional argument.
+
+    .. versionchanged:: 1.8
+
+       The ``context`` argument used to be called ``dictionary``. That name
+       is deprecated in Django 1.8 and will be removed in Django 2.0.
+
+``context_instance``
+    An instance of :class:`~django.template.Context` or a subclass (e.g., an
+    instance of :class:`~django.template.RequestContext`) to use as the
+    template's context. This can also be passed as the third positional argument.
+
+    .. deprecated:: 1.8
+
+       The ``context_instance`` argument is deprecated. Simply use ``context``.
+
+See also the :func:`~django.shortcuts.render_to_response()` shortcut, which
+calls ``render_to_string`` and feeds the result into an :class:`~django.http.HttpResponse`
+suitable for returning directly from a view.