summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Robertson <davidr@element.io>2022-06-15 20:10:04 +0100
committerDavid Robertson <davidr@element.io>2022-06-15 20:10:04 +0100
commitd132cbaf6d3812a9677dd640b4b622e1e23d5848 (patch)
tree893c800a6a6540f9750ea323ef9b494d4108c2e1
parentdebug (diff)
downloadsynapse-d132cbaf6d3812a9677dd640b4b622e1e23d5848.tar.xz
state AFTER the event, damnit
-rw-r--r--synapse/storage/controllers/state.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/synapse/storage/controllers/state.py b/synapse/storage/controllers/state.py
index d3a44bc876..fb54826bd7 100644
--- a/synapse/storage/controllers/state.py
+++ b/synapse/storage/controllers/state.py
@@ -287,7 +287,9 @@ class StateStorageController:
         self, event_id: str, state_filter: Optional[StateFilter] = None
     ) -> StateMap[str]:
         """
-        Get the state dict corresponding to a particular event
+        Get the state dict corresponding to a particular event.
+        Note that this is the state *after* the event: the event's changes have
+        already taken effect.
 
         Args:
             event_id: event whose state should be returned