summaryrefslogtreecommitdiff
path: root/lib/scoring/README.md
blob: 5beb0a28ffc9118caed016284606f2ed2a1e570f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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.