Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

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
  • Loading branch information...
commit d4623df4638823d4454a1fea4702801fbfb36df6 1 parent 3517550
@adrianholovaty adrianholovaty authored
Showing with 6 additions and 0 deletions.
  1. +6 −0 docs/model-api.txt
View
6 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``
~~~~~~~~~~~~~~~
Please sign in to comment.
Something went wrong with that request. Please try again.