summaryrefslogtreecommitdiff
path: root/lib/scoring
diff options
context:
space:
mode:
authornfoy <nfoy@purdue.edu>2014-04-27 19:12:07 -0400
committernfoy <nfoy@purdue.edu>2014-04-27 19:12:07 -0400
commit95542d38ddae5700e7fa35c166260a51ce17e46a (patch)
tree3ed1b9fcb793a426901586367dc5212819e9bff5 /lib/scoring
parent07dbbeb404dedcf9733262ae2ce9cdddc086bb0e (diff)
parent8b1e26bf00c7e536def47ae4ef3441192f154aa8 (diff)
Merge branch 'master' of https://github.com/LukeShu/leaguer
Diffstat (limited to 'lib/scoring')
-rw-r--r--lib/scoring/README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/scoring/README.md b/lib/scoring/README.md
index 95dd5e0..5beb0a2 100644
--- a/lib/scoring/README.md
+++ b/lib/scoring/README.md
@@ -1,10 +1,15 @@
-Files in this directory should be modules implementing the following
+Scoring interface
+=================
+
+Files in this directory should be _modules_ implementing the following
interface:
- `stats_needed() => Array[i]=Symbol`
+
Returns which statistics need to be collected for this scoring
algorithm.
- `score(match) => Hash[User]=Integer`
+
User scores for this match, assuming statistics have been
collected.