diff options
| author | Luke Shumaker <shumakl@purdue.edu> | 2014-04-27 18:22:19 -0400 |
|---|---|---|
| committer | Luke Shumaker <shumakl@purdue.edu> | 2014-04-27 18:22:19 -0400 |
| commit | cc7faa1bc3a542e0ea057971d37aa400f711d8c0 (patch) | |
| tree | 598bd26c9cac3eef04578e05f6f84f0fd720a256 /lib/scoring | |
| parent | 63e8f63b1a65247f7b272236af20fddaba96ef1e (diff) | |
tidy up README.md's
Diffstat (limited to 'lib/scoring')
| -rw-r--r-- | lib/scoring/README.md | 7 |
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. |