From 9bc23ba3aedd5742de896e8f0af28a67be9aa1df Mon Sep 17 00:00:00 2001
From: Thijs Kinkhorst <thijs@kinkhorst.com>
Date: Thu, 9 Jun 2022 10:12:52 +0200
Subject: [PATCH] cron: update docs to clarify purpose

---
 modules/cron/docs/cron.md | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/modules/cron/docs/cron.md b/modules/cron/docs/cron.md
index f6b159c6e..ac65bf489 100644
--- a/modules/cron/docs/cron.md
+++ b/modules/cron/docs/cron.md
@@ -1,13 +1,6 @@
 Cron
 =============================
 
-<!-- 
-	This file is written in Markdown syntax. 
-	For more information about how to use the Markdown syntax, read here:
-	http://daringfireball.net/projects/markdown/syntax
--->
-
-
 [TOC]
 
 Introduction
@@ -17,6 +10,13 @@ The cron module allows you to do tasks regularly, by setting up a cron
 job that calls a hook in SimpleSAMLphp.  This will invoke
 `hooks/hook_cron.php` in any enabled modules
 
+Modules, like e.g. the metarefresh module, that want to invoke tasks
+on set times, can register cron hooks for use by this module. You in turn
+configure your system's `cron` or other time based execution functionality
+to periodically trigger this module's endpoint, so all registered hooks
+will be executed at that time. This module also takes care of reporting
+back the result and provides an interface in SimpleSAMLphp's admin
+panel to trigger jobs manually.
 
 Preparations
 ------------
-- 
GitLab