From acaf30ad17709c1f9e678cbd7ca65ea6b3e55b90 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 24 Nov 2015 10:12:42 -0500 Subject: [PATCH] [1.8.x] Documented that forms.Field.help_text isn't HTML-escaped. Backport of a918f8b089a1d702c50c44742f433f3a546e0aa2 from master --- docs/ref/forms/fields.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index b6cb05b847..ac0d242d88 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -225,6 +225,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::