From 4d400cbb6c0f5aba5ae5f7518bf78d76422f2559 Mon Sep 17 00:00:00 2001 From: Alex Chen Date: Tue, 20 Aug 2019 16:31:38 +0800 Subject: [PATCH] Refine docs for QueryJoinedHostsInRoom --- federationsender/api/query.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/federationsender/api/query.go b/federationsender/api/query.go index 6046cc1bb..ebc6e833f 100644 --- a/federationsender/api/query.go +++ b/federationsender/api/query.go @@ -33,9 +33,9 @@ type QueryJoinedHostServerNamesInRoomResponse struct { // FederationSenderQueryAPI is used to query information from the federation sender. type FederationSenderQueryAPI interface { - // Query the joined hosts in a room. - // The membership events accounting for each server's participation are - // also contained in the response. + // Query the joined hosts and the membership events accounting for their participation in a room. + // Note that if a server has multiple users in the room, it will have multiple entries in the returned slice. + // See `QueryJoinedHostServerNamesInRoom` for a de-duplicated version. QueryJoinedHostsInRoom( ctx context.Context, request *QueryJoinedHostsInRoomRequest,