Skip to content

Commit

Permalink
POD: add synopsis from RankedPairs, start description
Browse files Browse the repository at this point in the history
  • Loading branch information
ikluft committed Nov 29, 2023
1 parent b0aa51c commit ee8423e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions src/perl/kr2/lib/PrefVote/KR2.pm
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,22 @@ __END__
=encoding utf8
=head1 SYNOPSIS
use PrefVote::KR2;
# count votes from a properly-formatted YAML file
my $vote_obj = PrefVote::KR2::file2vote($progname);
$vote_obj->count();
# get results in YAML
print YAML::XS::Dump($vote_obj->result_yaml());
# get results for your own handling
my $results = $vote_obj->results();
... process $results contents ...
=head1 DESCRIPTION
I<PrefVote::KR2> implements the Kluft Rank-Rate (KR2) preference voting algorithm for the I<PrefVote>
system.
KR2 is an experimental voting method under testing.

0 comments on commit ee8423e

Please sign in to comment.