MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-05-17 02:53:46 +02:00
Code Issues Projects Releases Wiki Activity

Clarify docs for some room state functions (#16950)

Browse source 
State *before* an event is different to state *after* that event, and
people tend to assume the wrong one.
This commit is contained in:
Richard van der Hoff 2024-03-19 17:16:37 +00:00 committed by GitHub
parent 42fa47a2a4
commit 9635822cc1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/16950.misc Normal file
View file

@ -0,0 +1 @@
Clarify docs for some room state functions.

8
synapse/storage/controllers/state.py
View file

@ -273,8 +273,10 @@ class StateStorageController:
await_full_state: bool = True,
) -> Dict[str, StateMap[str]]:
"""
Get the state dicts corresponding to a list of events, containing the event_ids
of the state events (as opposed to the events themselves)
Get the room states after each of a list of events.
For each event in `event_ids`, the result contains a map from state tuple
to the event_ids of the state event (as opposed to the events themselves).
Args:
event_ids: events whose state should be returned
@ -347,7 +349,7 @@ class StateStorageController:
await_full_state: bool = True,
) -> StateMap[str]:
"""
Get the state dict corresponding to a particular event
Get the state dict corresponding to the state after a particular event
Args:
event_id: event whose state should be returned