MDL-77837 core: Improve usage docs for cron::setup_user

This commit is contained in:
Andrew Nicols
2023-04-06 23:19:01 +08:00
parent 2dde341898
commit 25f1ec59d9
+6 -1
View File
@@ -573,7 +573,12 @@ class cron {
/**
* Sets up a user and course environment in cron.
* Do not use outside of cron script!
*
* Note: This function is intended only for use in:
* - the cron runner scripts
* - individual tasks which extend the adhoc_task and scheduled_task classes
* - unit tests related to tasks
* - other parts of the cron/task system
*
* Please note that this function stores cache data statically.
* @see reset_user_cache() to reset this cache.