From 13412263dcce381a341e6e378d1dffed6c6ebf0a Mon Sep 17 00:00:00 2001 From: domi41 Date: Sun, 25 Apr 2021 18:18:52 +0200 Subject: [PATCH] docs --- src/main/java/fr/mieuxvoter/mj/DeliberatorInterface.java | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/main/java/fr/mieuxvoter/mj/DeliberatorInterface.java b/src/main/java/fr/mieuxvoter/mj/DeliberatorInterface.java index ec93cda..4131fa3 100644 --- a/src/main/java/fr/mieuxvoter/mj/DeliberatorInterface.java +++ b/src/main/java/fr/mieuxvoter/mj/DeliberatorInterface.java @@ -3,14 +3,19 @@ package fr.mieuxvoter.mj; /** * A Deliberator takes in a poll's Tally, - * that is the amount of grades received by each Proposal, - * and outputs the poll's Result, + * that is the amount of judgments of each grade received by each Proposal, + * and outputs that poll's Result, * that is the final rank of each Proposal. + * Ranks start at 1 ("best"), and increment towards "worst". + * Two proposal may share the same rank, in extreme equality cases. * * This is the main API of this library. * * See MajorityJudgmentDeliberator for an implementation. + * One could implement other deliberators, such as CentralJudgment or UsualJudgment. */ public interface DeliberatorInterface { + public ResultInterface deliberate(TallyInterface tally); + }