summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2021-05-24 04:43:33 -0500
committerGitHub <noreply@github.com>2021-05-24 10:43:33 +0100
commit5f1198a67ebe182db14b5f98bb4c9a19d4889918 (patch)
treeb52aaaf3717bfdbf3b89740cd2f6625eb1f4f257
parentDon't hammer the database for destination retry timings every ~5mins (#10036) (diff)
downloadsynapse-5f1198a67ebe182db14b5f98bb4c9a19d4889918.tar.xz
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.
-rw-r--r--changelog.d/10050.misc1
-rw-r--r--synapse/storage/state.py2
2 files changed, 2 insertions, 1 deletions
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()