summaryrefslogtreecommitdiff
path: root/docs/model-api.txt
diff options
context:
space:
mode:
authorLuke Plant <L.Plant.98@cantab.net>2008-05-22 17:34:02 +0000
committerLuke Plant <L.Plant.98@cantab.net>2008-05-22 17:34:02 +0000
commit5b33adeafcabcc28dc6cab28ea80d0bc5fe445f4 (patch)
tree25ba78b195fb747a2428a3d850ccd1e306f9ba3a /docs/model-api.txt
parent875967ed3c62af66f890924524c52d7549c0f3db (diff)
Fixed documentation of 'description' option of Admin.fields to reflect actual behaviour
git-svn-id: http://code.djangoproject.com/svn/django/trunk@7545 bcc190cf-cafb-0310-a4f2-bffc1f526a37
Diffstat (limited to 'docs/model-api.txt')
-rw-r--r--docs/model-api.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/model-api.txt b/docs/model-api.txt
index 4ed4ede97a..554291396c 100644
--- a/docs/model-api.txt
+++ b/docs/model-api.txt
@@ -1372,9 +1372,10 @@ link. Fieldsets with the ``wide`` style will be given extra horizontal space.
``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.
+A string of optional extra text to be displayed at the top of each
+fieldset, under the heading of the fieldset. If you want this to
+include HTML, use ``django.utils.safestring.mark_safe`` so the HTML
+will not be escaped.
``js``
------