test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documented that forms.Field.help_text isn't HTML-escaped.

This commit is contained in:
Tim Graham 2015-11-24 10:12:42 -05:00
parent 9350616211
commit a918f8b089
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/ref/forms/fields.txt
View File

@ -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`` ``Field`` when the ``Field`` is rendered by one of the convenience ``Form``
methods (e.g., ``as_ul()``). 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 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:: fields. We've specified ``auto_id=False`` to simplify the output::