summaryrefslogtreecommitdiff
path: root/docs/ref/forms/api.txt
diff options
context:
space:
mode:
authorCarlton Gibson <carlton.gibson@noumenal.es>2022-04-26 16:01:59 +0200
committerCarlton Gibson <carlton.gibson@noumenal.es>2022-04-27 10:21:04 +0200
commit476d4d508717977101bba1a7f765653e48e88e76 (patch)
tree239da180ce3d0586406d3d1b36b5657bd40447a5 /docs/ref/forms/api.txt
parent832096478cf37b911688d061281348f74bf09e93 (diff)
Refs #32339 -- Allowed renderer to specify default form and formset templates.
Co-authored-by: David Smith <smithdc@gmail.com>
Diffstat (limited to 'docs/ref/forms/api.txt')
-rw-r--r--docs/ref/forms/api.txt18
1 files changed, 12 insertions, 6 deletions
diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt
index 4d3cf8997d..a6b4d11f4a 100644
--- a/docs/ref/forms/api.txt
+++ b/docs/ref/forms/api.txt
@@ -527,12 +527,18 @@ a form object, and each rendering method returns a string.
.. attribute:: Form.template_name
-The name of a template that is going to be rendered if the form is cast into a
-string, e.g. via ``print(form)`` or in a template via ``{{ form }}``. By
-default this template is ``'django/forms/default.html'``, which is a proxy for
-``'django/forms/table.html'``. The template can be changed per form by
-overriding the ``template_name`` attribute or more generally by overriding the
-default template, see also :ref:`overriding-built-in-form-templates`.
+The name of the template rendered if the form is cast into a string, e.g. via
+``print(form)`` or in a template via ``{{ form }}``.
+
+By default, a property returning the value of the renderer's
+:attr:`~django.forms.renderers.BaseRenderer.form_template_name`. You may set it
+as a string template name in order to override that for a particular form
+class.
+
+.. versionchanged:: 4.1
+
+ In older versions ``template_name`` defaulted to the string value
+ ``'django/forms/default.html'``.
``template_name_label``
-----------------------