From 4afac883900fe07c99552bbb6f56414b8b0ec81d Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 16 Dec 2014 13:07:48 +0000
Subject: [PATCH] Add basic docstring to annotate_context_with_state
---
synapse/state.py | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/synapse/state.py b/synapse/state.py
index d2763cdd9a..2f6eea09aa 100644
--- a/synapse/state.py
+++ b/synapse/state.py
@@ -137,6 +137,17 @@ class StateHandler(object):
@defer.inlineCallbacks
def annotate_context_with_state(self, event, context, old_state=None):
+ """ Fills out the context with the `current state` of the graph. The
+ `current state` here is defined to be exclusive of the given event,
+ i.e. its the state of the event graph just before the event.
+
+ If `event` has `auth_events` then this will also fill out the
+ `auth_events` field on `context` from the `current_state`.
+
+ Args:
+ event (EventBase)
+ context (EventContext)
+ """
yield run_on_reactor()
if old_state:
--
GitLab