diff options
| author | Tim Graham <timograham@gmail.com> | 2015-11-24 10:12:42 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2015-11-24 10:17:39 -0500 |
| commit | acaf30ad17709c1f9e678cbd7ca65ea6b3e55b90 (patch) | |
| tree | 6b96bcc645b0fb6fa0081fb052d1953defeee499 | |
| parent | 92d0d2cb1bf7fe68d966f7b383cdf0a4c44a0ba1 (diff) | |
[1.8.x] Documented that forms.Field.help_text isn't HTML-escaped.
Backport of a918f8b089a1d702c50c44742f433f3a546e0aa2 from master
| -rw-r--r-- | docs/ref/forms/fields.txt | 3 |
1 files changed, 3 insertions, 0 deletions
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:: |