Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix docstring in EventContext (#14145)

This commit is contained in:
Shay 2022-10-18 13:40:50 -07:00 committed by GitHub
parent 06b0c4edfe
commit 1c777ef1e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog.d/14145.doc Normal file
View File

@ -0,0 +1,2 @@
Clarify comment on event contexts.

3
synapse/events/snapshot.py
View File

@ -65,7 +65,8 @@ class EventContext:
None does not necessarily mean that ``state_group`` does not have None does not necessarily mean that ``state_group`` does not have
a prev_group! 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`` If ``state_group`` is None (ie, the event is an outlier), ``prev_group``
will always also be ``None``. will always also be ``None``.