summary refs log tree commit diff
diff options
context:
space:
mode:
authorShay <hillerys@element.io>2022-10-18 13:40:50 -0700
committerGitHub <noreply@github.com>2022-10-18 13:40:50 -0700
commit1c777ef1e87d7be39a2b8f6fb119fa4b51e2be4c (patch)
tree9d8b2aeaf4b83bac1b448d1773d7d17ed7a893c1
parentAdd aarch64 wheels to CI (#14212) (diff)
downloadsynapse-1c777ef1e87d7be39a2b8f6fb119fa4b51e2be4c.tar.xz
Fix docstring in EventContext (#14145)
-rw-r--r--changelog.d/14145.doc2
-rw-r--r--synapse/events/snapshot.py3
2 files changed, 4 insertions, 1 deletions
diff --git a/changelog.d/14145.doc b/changelog.d/14145.doc
new file mode 100644
index 0000000000..8f876e08fc
--- /dev/null
+++ b/changelog.d/14145.doc
@@ -0,0 +1,2 @@
+Clarify comment on event contexts.
+
diff --git a/synapse/events/snapshot.py b/synapse/events/snapshot.py
index d3c8083e4a..1c0e96bec7 100644
--- a/synapse/events/snapshot.py
+++ b/synapse/events/snapshot.py
@@ -65,7 +65,8 @@ class EventContext:
             None does not necessarily mean that ``state_group`` does not have
             a prev_group!
 
-            If the event is a state event, this is normally the same as ``prev_group``.
+            If the event is a state event, this is normally the same as
+            ``state_group_before_event``.
 
             If ``state_group`` is None (ie, the event is an outlier), ``prev_group``
             will always also be ``None``.