Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 2f18525

Browse files
committed
Fix comments
1 parent c049fce commit 2f18525

1 file changed

Lines changed: 3 additions & 24 deletions

File tree

synapse/events/snapshot.py

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ class EventContext:
5757
If ``state_group`` is None (ie, the event is an outlier),
5858
``state_group_before_event`` will always also be ``None``.
5959
60+
delta_before_after: If `state_group` and `state_group_before_event` are not None
61+
then this is the delta of the state between the two groups.
62+
6063
prev_group: If it is known, ``state_group``'s prev_group. Note that this being
6164
None does not necessarily mean that ``state_group`` does not have
6265
a prev_group!
@@ -75,30 +78,6 @@ class EventContext:
7578
app_service: If this event is being sent by a (local) application service, that
7679
app service.
7780
78-
_current_state_ids: The room state map, including this event - ie, the state
79-
in ``state_group``.
80-
81-
(type, state_key) -> event_id
82-
83-
For an outlier, this is {}
84-
85-
Note that this is a private attribute: it should be accessed via
86-
``get_current_state_ids``. _AsyncEventContext impl calculates this
87-
on-demand: it will be None until that happens.
88-
89-
_prev_state_ids: The room state map, excluding this event - ie, the state
90-
in ``state_group_before_event``. For a non-state
91-
event, this will be the same as _current_state_events.
92-
93-
Note that it is a completely different thing to prev_group!
94-
95-
(type, state_key) -> event_id
96-
97-
For an outlier, this is {}
98-
99-
As with _current_state_ids, this is a private attribute. It should be
100-
accessed via get_prev_state_ids.
101-
10281
partial_state: if True, we may be storing this event with a temporary,
10382
incomplete state.
10483
"""

0 commit comments

Comments
 (0)