Ticket #1834: admin_templatetags_docstrings.diff

django/contrib/admin/templatetags/admin_list.py

@@ -21 +21 @@
 DOT = '.'
 
 def paginator_number(cl,i):
+    """
+    Generates an individual page index link in a paginated list.
+    """
     if i == DOT:
         return u'... '
     elif i == cl.page_num:
@@ -30 +33 @@
 paginator_number = register.simple_tag(paginator_number)
 
 def pagination(cl):
+    """
+    Generates the series of links to the pages in a paginated list.
+    """
     paginator, page_num = cl.paginator, cl.page_num
 
     pagination_required = (not cl.show_all or not cl.can_show_all) and cl.multi_page
@@ -73 +79 @@
 pagination = register.inclusion_tag('admin/pagination.html')(pagination)
 
 def result_headers(cl):
+    """
+    Generates the list column headers.
+    """
     lookup_opts = cl.lookup_opts
 
     for i, field_name in enumerate(cl.list_display):
@@ -118 +127 @@
     return mark_safe(u'<img src="%simg/admin/icon-%s.gif" alt="%s" />' % (settings.ADMIN_MEDIA_PREFIX, BOOLEAN_MAPPING[field_val], field_val))
 
 def items_for_result(cl, result, form):
+    """
+    Generates the actual list of data.
+    """
     first = True
     pk = cl.lookup_opts.pk.attname
     for field_name in cl.list_display:
@@ -189 +201 @@
             yield list(items_for_result(cl, res, None))
 
 def result_list(cl):
+    """
+    Displays the headers and data list together
+    """
     return {'cl': cl,
             'result_headers': list(result_headers(cl)),
             'results': list(results(cl))}
 result_list = register.inclusion_tag("admin/change_list_results.html")(result_list)
 
 def date_hierarchy(cl):
+    """
+    Displays the date hierarchy for date drill-down functionality.
+    """
     if cl.date_hierarchy:
         field_name = cl.date_hierarchy
         year_field = '%s__year' % field_name
@@ -255 +273 @@
 date_hierarchy = register.inclusion_tag('admin/date_hierarchy.html')(date_hierarchy)
 
 def search_form(cl):
+    """
+    Displays a search form for searching the list.
+    """
     return {
         'cl': cl,
         'show_result_count': cl.result_count != cl.full_result_count,

django/contrib/admin/templatetags/admin_modify.py

@@ -20 +20 @@
 prepopulated_fields_js = register.inclusion_tag('admin/prepopulated_fields_js.html', takes_context=True)(prepopulated_fields_js)
 
 def submit_row(context):
+    """
+    Displays the row of buttons for delete and save. 
+    """
     opts = context['opts']
     change = context['change']
     is_popup = context['is_popup']