Diff

plugins/mod_mam/mod_mam.lua @ 12555:519e6403f455

mod_mam: Clarify comment (thanks chili-b) This was slightly inaccurate since 6e1af07921d1 because the conditions are more complicated now.
author Kim Alvefur <zash@zash.se>
date Tue, 14 Jun 2022 22:03:02 +0200
parent 12307:dcad3a207915
child 12556:706375b75475
line wrap: on
line diff
--- a/plugins/mod_mam/mod_mam.lua	Tue Jun 14 19:21:20 2022 +0200
+++ b/plugins/mod_mam/mod_mam.lua	Tue Jun 14 22:03:02 2022 +0200
@@ -53,8 +53,12 @@
 end
 local use_total = module:get_option_boolean("mam_include_total", true);
 
-function schedule_cleanup()
-	-- replaced later if cleanup is enabled
+function schedule_cleanup(_username, _date)
+	-- Called to make a note of which users have messages on which days, which in
+	-- turn is used to optimize the message expiry routine.
+	--
+	-- This noop is conditionally replaced later depending on retention settings
+	-- and storage backend capabilities.
 end
 
 -- Handle prefs.