summary refs log tree commit diff
path: root/synapse/storage
diff options
context:
space:
mode:
authorOlivier Wilkinson (reivilibre) <oliverw@matrix.org>2022-10-06 15:47:05 +0100
committerOlivier Wilkinson (reivilibre) <oliverw@matrix.org>2022-10-06 16:01:33 +0100
commit46e0acc602fdb8e3b7d10bfd78fc9f31e93892ed (patch)
treef9cadc8c5d3cf06608f1e1377738e2c337657361 /synapse/storage
parentRename get_prev_events_for_room to get_prev_events_for_full_state_room (diff)
downloadsynapse-46e0acc602fdb8e3b7d10bfd78fc9f31e93892ed.tar.xz
Rename get_prev_events to make it more obvious
Diffstat (limited to 'synapse/storage')
-rw-r--r--synapse/storage/databases/main/event_federation.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/synapse/storage/databases/main/event_federation.py b/synapse/storage/databases/main/event_federation.py
index 7aae0ceb48..b32b85646a 100644
--- a/synapse/storage/databases/main/event_federation.py
+++ b/synapse/storage/databases/main/event_federation.py
@@ -1062,7 +1062,7 @@ class EventFederationWorkerStore(SignatureWorkerStore, EventsWorkerStore, SQLBas
 
             return min_depth_event_id, current_min_depth
 
-    async def get_prev_events_for_room(self, room_id: str) -> List[str]:
+    async def get_prev_events_for_full_state_room(self, room_id: str) -> List[str]:
         """
         Gets a subset of the current forward extremities in the given room.
 
@@ -1073,7 +1073,8 @@ class EventFederationWorkerStore(SignatureWorkerStore, EventsWorkerStore, SQLBas
             room_id: room_id
 
         Returns:
-            The event ids of the forward extremities.
+            The event ids of up to 10 of the forward extremities,
+            suitable for using as `prev_events` in a full-state room.
         """
 
         return await self.db_pool.runInteraction(