From d4623df4638823d4454a1fea4702801fbfb36df6 Mon Sep 17 00:00:00 2001
From: Adrian Holovaty <adrian@holovaty.com>
Date: Mon, 6 Aug 2007 05:33:18 +0000
Subject: [PATCH] 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
---
 docs/model-api.txt | 6 ++++++
 1 file changed, 6 insertions(+)

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``
 ~~~~~~~~~~~~~~~