summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2015-11-24 10:12:42 -0500
committerTim Graham <timograham@gmail.com>2015-11-24 10:17:16 -0500
commita918f8b089a1d702c50c44742f433f3a546e0aa2 (patch)
tree5c95cfc91c599fb84dd6bf4a76b181adcae737c2 /docs
parent935061621136ddb4e4ca65a1861ee57e4e3dda09 (diff)
Documented that forms.Field.help_text isn't HTML-escaped.
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/forms/fields.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt
index eb4a0ab69a..b7a0fe3b6c 100644
--- a/docs/ref/forms/fields.txt
+++ b/docs/ref/forms/fields.txt
@@ -223,6 +223,9 @@ The ``help_text`` argument lets you specify descriptive text for this
``Field`` when the ``Field`` is rendered by one of the convenience ``Form``
methods (e.g., ``as_ul()``).
+Like the model field's :attr:`~django.db.models.Field.help_text`, this value
+isn't HTML-escaped in automatically-generated forms.
+
Here's a full example ``Form`` that implements ``help_text`` for two of its
fields. We've specified ``auto_id=False`` to simplify the output::