diff options
| author | Luke Plant <L.Plant.98@cantab.net> | 2008-07-25 14:47:35 +0000 |
|---|---|---|
| committer | Luke Plant <L.Plant.98@cantab.net> | 2008-07-25 14:47:35 +0000 |
| commit | 7c0cf545efbad0c609b9d539c85e532e5c115cd3 (patch) | |
| tree | 066d54f2c4ad1e063686b532e4c108363bba3e88 /docs | |
| parent | 3992683ea349e2843a710e79c1c69ac2d80bb1ac (diff) | |
Standardised documentation of the Field help_text option and ModelAdmin.fields 'description' option.
git-svn-id: http://code.djangoproject.com/svn/django/trunk@8074 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin.txt | 9 | ||||
| -rw-r--r-- | docs/model-api.txt | 3 |
2 files changed, 10 insertions, 2 deletions
diff --git a/docs/admin.txt b/docs/admin.txt index 565068e11b..df96aa944b 100644 --- a/docs/admin.txt +++ b/docs/admin.txt @@ -139,8 +139,13 @@ The ``field_options`` dictionary can have the following keys: ``description`` A string of optional extra text to be displayed at the top of each fieldset, - under the heading of the fieldset. It's used verbatim, so you can use any HTML - and you must escape any special HTML characters (such as ampersands) yourself. + under the heading of the fieldset. + + Note that this value is *not* HTML-escaped when it's displayed in + the admin interface. This lets you include HTML if you so desire. + Alternatively you can use plain text and + ``django.utils.html.escape()`` to escape any HTML special + characters. ``filter_horizontal`` ~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/model-api.txt b/docs/model-api.txt index 9a353c0ec4..35731b03ff 100644 --- a/docs/model-api.txt +++ b/docs/model-api.txt @@ -658,6 +658,9 @@ example:: help_text="Please use the following format: <em>YYYY-MM-DD</em>." +Alternatively you can use plain text and +``django.utils.html.escape()`` to escape any HTML special characters. + ``primary_key`` ~~~~~~~~~~~~~~~ |