From 6f5cf19bf959c40d10fa4c2340aada058a13fa45 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Mon, 7 Aug 2017 16:17:15 +0100 Subject: [PATCH] Comment on the purpose of updateMembership --- .../matrix-org/dendrite/roomserver/input/membership.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/github.com/matrix-org/dendrite/roomserver/input/membership.go b/src/github.com/matrix-org/dendrite/roomserver/input/membership.go index 14b98a319..7651e7c3c 100644 --- a/src/github.com/matrix-org/dendrite/roomserver/input/membership.go +++ b/src/github.com/matrix-org/dendrite/roomserver/input/membership.go @@ -22,6 +22,10 @@ import ( "github.com/matrix-org/gomatrixserverlib" ) +// updateMembership updates the current membership and the invites for each +// user affected by a change in the current state of the room. +// Returns a list of output events to write to the kafka log to inform the +// consumers about the invites added or retired by the change in current state. func updateMemberships( db RoomEventDatabase, updater types.RoomRecentEventsUpdater, removed, added []types.StateEntry, ) ([]api.OutputEvent, error) {