summary refs log tree commit diff
path: root/synapse/events/snapshot.py
diff options
context:
space:
mode:
authorRichard van der Hoff <richard@matrix.org>2018-02-13 12:16:01 +0000
committerRichard van der Hoff <richard@matrix.org>2018-02-13 12:16:01 +0000
commita9b712e9dce119c65fe24913d2a79212ae07a354 (patch)
tree2c98b0b3d7d31c59ce41db257c3a18c5b3a2df03 /synapse/events/snapshot.py
parentFactor out common code for search insert (diff)
parentMerge pull request #2857 from matrix-org/erikj/upload_store (diff)
downloadsynapse-a9b712e9dce119c65fe24913d2a79212ae07a354.tar.xz
Merge branch 'develop' into matthew/gin_work_mem
Diffstat (limited to 'synapse/events/snapshot.py')
-rw-r--r--synapse/events/snapshot.py4
1 files changed, 3 insertions, 1 deletions
diff --git a/synapse/events/snapshot.py b/synapse/events/snapshot.py
index e9a732ff03..87e3fe7b97 100644
--- a/synapse/events/snapshot.py
+++ b/synapse/events/snapshot.py
@@ -25,7 +25,9 @@ class EventContext(object):
             The current state map excluding the current event.
             (type, state_key) -> event_id
 
-        state_group (int): state group id
+        state_group (int|None): state group id, if the state has been stored
+            as a state group. This is usually only None if e.g. the event is
+            an outlier.
         rejected (bool|str): A rejection reason if the event was rejected, else
             False