[#3018] Small docstring and param name tweak

ckan/lib/activity_streams.py

@@ -187,15 +187,18 @@ def activity_stream_string_new_related_item():
 # A list of activity types that may have details
 activity_stream_actions_with_detail = ['changed package']
 
-def activity_list_to_html(context, activity_stream, activity_params):
+def activity_list_to_html(context, activity_stream, extra_vars):
     '''Return the given activity stream as a snippet of HTML.
 
-    :param activity_stream: Array of activity items
-    :param activity_params: Dictionary of params that the load more button needs for context
+    :param activity_stream: the activity stream to render
+    :type activity_stream: list of activity dictionaries
+    :param extra_vars: extra variables to pass to the activity stream items
+        template when rendering it
+    :type extra_vars: dictionary
 
-    :rtype html of activity list
-    '''
+    :rtype: HTML-formatted string
 
+    '''
     activity_list = [] # These are the activity stream messages.
     for activity in activity_stream:
         detail = None
@@ -242,6 +245,6 @@ def activity_list_to_html(context, activity_stream, activity_params):
                               'data': data,
                               'timestamp': activity['timestamp'],
                               'is_new': activity.get('is_new', False)})
-    activity_params['activities'] = activity_list
+    extra_vars['activities'] = activity_list
     return literal(base.render('activity_streams/activity_stream_items.html',
-        extra_vars=activity_params))
+        extra_vars=extra_vars))

ckan/logic/action/get.py

@@ -1828,13 +1828,14 @@ def user_activity_list_html(context, data_dict):
     '''
     activity_stream = user_activity_list(context, data_dict)
     offset = int(data_dict.get('offset', 0))
-    activity_params = {
+    extra_vars = {
         'controller': 'user',
         'action': 'activity',
         'id': data_dict['id'],
         'offset': offset,
         }
-    return activity_streams.activity_list_to_html(context, activity_stream, activity_params)
+    return activity_streams.activity_list_to_html(context, activity_stream,
+            extra_vars)
 
 def package_activity_list_html(context, data_dict):
     '''Return a package's activity stream as HTML.
@@ -1852,13 +1853,14 @@ def package_activity_list_html(context, data_dict):
     '''
     activity_stream = package_activity_list(context, data_dict)
     offset = int(data_dict.get('offset', 0))
-    activity_params = {
+    extra_vars = {
         'controller': 'package',
         'action': 'activity',
         'id': data_dict['id'],
         'offset': offset,
         }
-    return activity_streams.activity_list_to_html(context, activity_stream, activity_params)
+    return activity_streams.activity_list_to_html(context, activity_stream,
+            extra_vars)
 
 def group_activity_list_html(context, data_dict):
     '''Return a group's activity stream as HTML.
@@ -1876,13 +1878,14 @@ def group_activity_list_html(context, data_dict):
     '''
     activity_stream = group_activity_list(context, data_dict)
     offset = int(data_dict.get('offset', 0))
-    activity_params = {
+    extra_vars = {
         'controller': 'group',
         'action': 'activity',
         'id': data_dict['id'],
         'offset': offset,
         }
-    return activity_streams.activity_list_to_html(context, activity_stream, activity_params)
+    return activity_streams.activity_list_to_html(context, activity_stream,
+            extra_vars)
 
 def recently_changed_packages_activity_list_html(context, data_dict):
     '''Return the activity stream of all recently changed packages as HTML.
@@ -1899,13 +1902,14 @@ def recently_changed_packages_activity_list_html(context, data_dict):
     activity_stream = recently_changed_packages_activity_list(context,
             data_dict)
     offset = int(data_dict.get('offset', 0))
-    activity_params = {
+    extra_vars = {
         'controller': 'package',
         'action': 'activity',
         'id': data_dict['id'],
         'offset': offset,
         }
-    return activity_streams.activity_list_to_html(context, activity_stream, activity_params)
+    return activity_streams.activity_list_to_html(context, activity_stream,
+            extra_vars)
 
 
 def _follower_count(context, data_dict, default_schema, ModelClass):
@@ -2265,13 +2269,14 @@ def dashboard_activity_list_html(context, data_dict):
     '''
     activity_stream = dashboard_activity_list(context, data_dict)
     offset = int(data_dict.get('offset', 0))
-    activity_params = {
+    extra_vars = {
         'controller': 'dashboard',
         'action': 'activity',
         'id': data_dict['id'],
         'offset': offset,
         }
-    return activity_streams.activity_list_to_html(context, activity_stream, activity_params)
+    return activity_streams.activity_list_to_html(context, activity_stream,
+            extra_vars)
 
 
 def dashboard_new_activities_count(context, data_dict):
@@ -2330,4 +2335,4 @@ def _unpick_search(sort, allowed_fields=None, total=None):
     if total and len(sorts) > total:
         raise logic.ParameterError(
             'Too many sort criteria provided only %s allowed' % total)
-    return sorts
+    return sorts