martinlackner / abcvoting

Python implementations of approval-based committee (multi-winner) voting rules
https://abcvoting.readthedocs.io/
MIT License
32 stars 16 forks source link

Clarify docstring about weights #69

Closed DominikPeters closed 1 year ago

DominikPeters commented 1 year ago

The documentation regarding Voter.weight said:

This should not be used as the number of voters with these approved candidates.

I'm not sure what this means, so I've replace it with:

If weight is an integer, the voter is interpreted as if there are weight many voters with the same approval set.

codecov-commenter commented 1 year ago

Codecov Report

Merging #69 (6329cfd) into master (cbd70e7) will not change coverage. The diff coverage is n/a.

:exclamation: Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #69   +/-   ##
=======================================
  Coverage   91.76%   91.76%           
=======================================
  Files          11       11           
  Lines        3400     3400           
  Branches     1072     1072           
=======================================
  Hits         3120     3120           
  Misses        161      161           
  Partials      119      119           
Impacted Files Coverage Δ
abcvoting/preferences.py 100.00% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update cbd70e7...6329cfd. Read the comment docs.