From 6260b8e2480fb38b2d8d6bbd5a8f230f83a29cd8 Mon Sep 17 00:00:00 2001
From: Siebrand Mazeland <siebrand@users.mediawiki.org>
Date: Thu, 5 Jan 2012 10:07:48 +0000
Subject: [PATCH] Add some documentation for settings per CR on r108127.

---
 ContributionScores.php | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/ContributionScores.php b/ContributionScores.php
index 69a7551..bc04179 100644
--- a/ContributionScores.php
+++ b/ContributionScores.php
@@ -22,10 +22,12 @@ $dir = dirname( __FILE__ ) . '/';
 
 define( 'CONTRIBUTIONSCORES_MAXINCLUDELIMIT', 50 );
 $wgContribScoreReports = null;
-$wgContribScoreIgnoreBlockedUsers = false;
-$wgContribScoreIgnoreBots = false;
-$wgContribScoresUseRealName = false;
-$wgContribScoreDisableCache = false;
+
+// These settings can be overridden in LocalSettings.php.
+$wgContribScoreIgnoreBlockedUsers = false; // Set to true to exclude bots from the reporting.
+$wgContribScoreIgnoreBots = false; // Set to true to exclude blocked users from the reporting.
+$wgContribScoresUseRealName = false; // Set to true to use real user names when available. Only for MediaWiki 1.19 and later.
+$wgContribScoreDisableCache = false; // Set to true to disable cache for parser function and inclusion of table.
 
 $wgAutoloadClasses['ContributionScores'] = $dir . 'ContributionScores_body.php';
 $wgSpecialPages['ContributionScores'] = 'ContributionScores';