add some doc string for build_nav_main

ckan · May 17, 2012 · 7dc043e · 7dc043e
1 parent 12c79ec
commit 7dc043e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/ckan/lib/helpers.py b/ckan/lib/helpers.py
@@ -352,6 +352,11 @@ def _subnav_named_route(text, routename, **kwargs):
     )
 
 def build_nav_main(*args):
+    ''' build a set of menu items.
+
+    args: tuples of (menu type, title) eg ('login', _('Login'))
+    outputs <li><a href="...">title</a></li>
+    '''
     output = ''
     for item in args:
         menu_item, title = item