From 5f1198a67ebe182db14b5f98bb4c9a19d4889918 Mon Sep 17 00:00:00 2001
From: Eric Eastwood <erice@element.io>
Date: Mon, 24 May 2021 04:43:33 -0500
Subject: [PATCH] Fix `get_state_ids_for_event` return type typo to match what
the function actually does (#10050)
It looks like a typo copy/paste from `get_state_for_event` above.
---
changelog.d/10050.misc | 1 +
synapse/storage/state.py | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)
create mode 100644 changelog.d/10050.misc
diff --git a/changelog.d/10050.misc b/changelog.d/10050.misc
new file mode 100644
index 0000000000..2cac953cca
--- /dev/null
+++ b/changelog.d/10050.misc
@@ -0,0 +1 @@
+Fix typo in `get_state_ids_for_event` docstring where the return type was incorrect.
diff --git a/synapse/storage/state.py b/synapse/storage/state.py
index cfafba22c5..c9dce726cb 100644
--- a/synapse/storage/state.py
+++ b/synapse/storage/state.py
@@ -540,7 +540,7 @@ class StateGroupStorage:
state_filter: The state filter used to fetch state from the database.
Returns:
- A dict from (type, state_key) -> state_event
+ A dict from (type, state_key) -> state_event_id
"""
state_map = await self.get_state_ids_for_events(
[event_id], state_filter or StateFilter.all()
--
GitLab