Ticket #1834: include_admin_script_doc.diff

contrib/admin/templatetags/admin_modify.py

@@ -18 +18 @@
     return '_'.join([s.lower() for s in word_re.findall(name)[:-1]])
 
 def include_admin_script(script_path):
+    """
+    return a script-tag suitable for including a script from the admin
+    media url.
+
+    example::
+
+        {% include_admin_script js/calendar.js %}
+
+    could return::
+
+        <script type="text/javascript" src="/media/admin/js/calendar.js">
+    """
+
     return '<script type="text/javascript" src="%s%s"></script>' % (settings.ADMIN_MEDIA_PREFIX, script_path)
 include_admin_script = register.simple_tag(include_admin_script)