MUC: Add some comments clarifying methods
authorMatthew Wild <mwild1@gmail.com>
Tue, 17 Jul 2018 10:35:33 +0100
changeset 9054 68386f7b9fc9
parent 9053 f5c43e829d93
child 9055 5017e43ccc39
MUC: Add some comments clarifying methods
plugins/muc/mod_muc.lua
--- a/plugins/muc/mod_muc.lua	Tue Jul 17 10:29:16 2018 +0100
+++ b/plugins/muc/mod_muc.lua	Tue Jul 17 10:35:33 2018 +0100
@@ -207,12 +207,14 @@
 	end
 end
 
+-- Removes a room from memory, without saving it (save first if required)
 function forget_room(room)
 	module:log("debug", "Forgetting %s", room.jid);
 	rooms.save = nil;
 	rooms:set(room.jid, nil);
 end
 
+-- Removes a room from the database (may remain in memory)
 function delete_room(room)
 	module:log("debug", "Deleting %s", room.jid);
 	room_configs:set(jid_split(room.jid), nil);