diff options
| author | Adrian Holovaty <adrian@holovaty.com> | 2007-08-06 05:33:18 +0000 |
|---|---|---|
| committer | Adrian Holovaty <adrian@holovaty.com> | 2007-08-06 05:33:18 +0000 |
| commit | d4623df4638823d4454a1fea4702801fbfb36df6 (patch) | |
| tree | 9b133a339a7f4143d7a24c3c057b57ecd4fb7901 /docs | |
| parent | 3517550dacaed6933c390d2d1f7e78c67c04aec4 (diff) | |
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
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/model-api.txt | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/model-api.txt b/docs/model-api.txt index 4bf5648bf0..3b634de1d8 100644 --- a/docs/model-api.txt +++ b/docs/model-api.txt @@ -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 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`` ~~~~~~~~~~~~~~~ |