Added note to docs/model-api.txt about help_text not being escaped in the admin interface
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5816 bcc190cf-cafb-0310-a4f2-bffc1f526a37
This commit is contained in:
parent
3517550dac
commit
d4623df463
|
@ -624,6 +624,12 @@ Extra "help" text to be displayed under the field on the object's admin
|
||||||
form. It's useful for documentation even if your object doesn't have an
|
form. It's useful for documentation even if your object doesn't have an
|
||||||
admin form.
|
admin form.
|
||||||
|
|
||||||
|
Note that this value is *not* HTML-escaped when it's displayed in the admin
|
||||||
|
interface. This lets you include HTML in ``help_text`` if you so desire. For
|
||||||
|
example::
|
||||||
|
|
||||||
|
help_text="Please use the following format: <em>YYYY-MM-DD</em>."
|
||||||
|
|
||||||
``primary_key``
|
``primary_key``
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue