Add actors argument documentation.

ambitioninc · Dec 18, 2014 · 3553fcd · 3553fcd
1 parent 8e444fe
commit 3553fcd
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/entity_event/models.py b/entity_event/models.py
@@ -121,6 +121,10 @@ def site_feed(request):
             results. Passing in ``True`` to this argument causes
             expired events to be returned as well.
 
+        :type actor: Entity (optional)
+        :param actor: Only include events with the given entity as an
+            actor.
+
         :type mark_seen: Boolean (optional)
         :param mark_seen: Create a side effect in the database that
             marks all the returned events as having been seen by this
@@ -212,6 +216,10 @@ def newsfeed(request):
             results. Passing in ``True`` to this argument causes
             expired events to be returned as well.
 
+        :type actor: Entity (optional)
+        :param actor: Only include events with the given entity as an
+            actor.
+
         :type mark_seen: Boolean (optional)
         :param mark_seen: Create a side effect in the database that
             marks all the returned events as having been seen by this
@@ -303,6 +311,10 @@ def events_targets(self, entity_kind=None, **event_filters):
             results. Passing in ``True`` to this argument causes
             expired events to be returned as well.
 
+        :type actor: Entity (optional)
+        :param actor: Only include events with the given entity as an
+            actor.
+
         :type mark_seen: Boolean (optional)
         :param mark_seen: Create a side effect in the database that
             marks all the returned events as having been seen by this