summary refs log tree commit diff
path: root/synapse
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2014-12-16 13:32:06 +0000
committerErik Johnston <erik@matrix.org>2014-12-16 13:32:06 +0000
commit8133cdcc88aa54480bfab41eb017e6b024b55c7e (patch)
treeb222b48652a70f1338d9a8ee14bbf9866cea36d1 /synapse
parentUpdate upgrade script (diff)
downloadsynapse-8133cdcc88aa54480bfab41eb017e6b024b55c7e.tar.xz
Better english in docstrings are helpful.
Diffstat (limited to '')
-rw-r--r--synapse/state.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/synapse/state.py b/synapse/state.py
index 2f6eea09aa..38adde4dc9 100644
--- a/synapse/state.py
+++ b/synapse/state.py
@@ -138,8 +138,8 @@ 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.
+        `current state` here is defined to be the state of the event graph
+        just before the event - i.e. it never includes `event`
 
         If `event` has `auth_events` then this will also fill out the
         `auth_events` field on `context` from the `current_state`.