Document a function

wireapp · Jan 24, 2023 · 82a0a59 · 82a0a59
1 parent a0f44f6
commit 82a0a59
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/services/galley/src/Galley/API/Message.hs b/services/galley/src/Galley/API/Message.hs
@@ -553,6 +553,9 @@ sendLocalMessages loc now sender senderClient mconn qcnv botMap metadata localMe
   runMessagePush @t loc qcnv (pushes ^. traversed)
   pure mempty
 
+-- | Send remote messages to the backend given by the domain argument, and
+-- return the set of clients for which sending has failed. In case there was no
+-- failure, the empty set is returned.
 sendRemoteMessages ::
   forall r x.
   (Members '[FederatorAccess, P.TinyLog] r, CallsFed 'Galley "on-message-sent") =>