From 6875e62942dbe582611890071e110536f34b60dd Mon Sep 17 00:00:00 2001
From: Thomas Keller <me@thomaskeller.biz>
Date: Fri, 23 Dec 2011 01:06:13 +0100
Subject: [PATCH] Add some more documentary to the cronjob.

---
 scripts/activitycron.php | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/scripts/activitycron.php b/scripts/activitycron.php
index 3a7717e..43f91d9 100644
--- a/scripts/activitycron.php
+++ b/scripts/activitycron.php
@@ -25,6 +25,13 @@
  * This script recalculates the "project activity" for all of the
  * forge's projects for the given date.
  * If no date is given, yesterday's date is used.
+ *
+ * This script should run once a day. You can configure its behaviour
+ * with $cfg['activity_section_weights'] and $cfg['activity_lookback'].
+ *
+ * If the script runs more than once with the same date argument,
+ * previously recorded project activity values are replaced with the
+ * newly created ones.
  */
 
 require dirname(__FILE__).'/../src/IDF/conf/path.php';