Add docstring to group_activity_list()

ckan · Nov 22, 2012 · 8225e73 · 8225e73
1 parent 61eddb3
commit 8225e73
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/ckan/model/activity.py b/ckan/model/activity.py
@@ -149,6 +149,16 @@ def _group_activity_query(group_id, limit=15):
 
 
 def group_activity_list(group_id, limit=15):
+    '''Return the given group's public activity stream.
+
+    Returns all activities where the given group or one of its datasets is the
+    object of the activity, e.g.:
+
+    "{USER} updated the group {GROUP}"
+    "{USER} updated the dataset {DATASET}"
+    etc.
+
+    '''
     q = _group_activity_query(group_id)
     return _most_recent_activities(q, limit)