Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify docs for some room state functions #16950

Merged
merged 1 commit into from Mar 19, 2024
Merged

Clarify docs for some room state functions #16950

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/16950.misc
View file
Open in desktop
@@ -0,0 +1 @@
Clarify docs for some room state functions.
8 changes: 5 additions & 3 deletions synapse/storage/controllers/state.py
View file
Open in desktop
Expand Up @@ -273,8 +273,10 @@ async def get_state_ids_for_events(
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
Expand Down Expand Up @@ -347,7 +349,7 @@ async def get_state_ids_for_event(
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
Expand Down