From 3553fcdce702303fbe07fc7010f0d49c6348c4a8 Mon Sep 17 00:00:00 2001 From: Erik Swanson Date: Thu, 18 Dec 2014 16:56:18 -0500 Subject: [PATCH] Add actors argument documentation. --- entity_event/models.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/entity_event/models.py b/entity_event/models.py index 18b0e0b..4317324 100644 --- 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