mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-19 10:10:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

[1.9.x] Documented that forms.Field.help_text isn't HTML-escaped.

Browse source 
Backport of a918f8b089 from master
This commit is contained in:
Tim Graham 2015-11-24 10:12:42 -05:00
parent c7d1a96658
commit 7fccc6e8fa
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -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`` ``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::