From 1c777ef1e87d7be39a2b8f6fb119fa4b51e2be4c Mon Sep 17 00:00:00 2001
From: Shay <hillerys@element.io>
Date: Tue, 18 Oct 2022 13:40:50 -0700
Subject: [PATCH] Fix docstring in EventContext (#14145)

---
 changelog.d/14145.doc      | 2 ++
 synapse/events/snapshot.py | 3 ++-
 2 files changed, 4 insertions(+), 1 deletion(-)
 create mode 100644 changelog.d/14145.doc

diff --git a/changelog.d/14145.doc b/changelog.d/14145.doc
new file mode 100644
index 000000000..8f876e08f
--- /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 d3c8083e4..1c0e96bec 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``.