# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1655236982 -7200
# Node ID 519e6403f4551a99981562d4fb283b7f7f9f9647
# Parent  dbbbcf6b805e7fcb0761efd2c62f719ac1468031
mod_mam: Clarify comment (thanks chili-b)

This was slightly inaccurate since 6e1af07921d1 because the conditions
are more complicated now.

diff -r dbbbcf6b805e -r 519e6403f455 plugins/mod_mam/mod_mam.lua
--- 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.