Attempt to clarify docstring for get_receipts_for_user.

matrix-org · Apr 28, 2022 · 0501bbc · DMRobertson · Apr 28, 2022 · 0501bbc
1 parent 6d1d865
commit 0501bbc
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/synapse/storage/databases/main/receipts.py b/synapse/storage/databases/main/receipts.py
@@ -176,14 +176,17 @@ async def get_receipts_for_user(
         self, user_id: str, receipt_type: str
     ) -> Dict[str, str]:
         """
-        Fetch the event IDs for the latest receipt in all rooms with the given receipt type.
+        Fetch the event IDs for the latest receipt sent by the given user.
 
         Args:
             user_id: The user to fetch receipts for.
             receipt_type: The receipt types to fetch.
 
         Returns:
             A map of room ID to the event ID of the latest receipt for that room.
+
+            If the user has not sent a receipt to a room then it will not appear
+            in the returned dictionary.
         """
         rows = await self.db_pool.simple_select_list(
             table="receipts_linearized",