Skip to content

Commit

Permalink
Move examples link alongside examples, fix doctest
Browse files Browse the repository at this point in the history
  • Loading branch information
endolith committed May 3, 2023
1 parent 8efde2e commit 84cb77b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Or the table of Effectiveness from [Weber 1977](https://elischolar.library.yale.
| 10 | 50.78 | 82.94 | 95.35 |
| 255 | 12.78 | 86.37 | 99.80 |

See [/examples](./examples) folder for more on what it can do, such as reproductions of previous research.

## Goals

- Fast (~25,000 elections per second on Core i7-9750H)
Expand Down Expand Up @@ -54,10 +56,10 @@ Specify an election with three candidates (0, 1, 2), where two voters rank candi

```python
>>> election = [[0, 2, 1],
[0, 2, 1],
[1, 2, 0],
[1, 2, 0],
[2, 0, 1]]
... [0, 2, 1],
... [1, 2, 0],
... [1, 2, 0],
... [2, 0, 1]]
```

Calculate the winner using Black's method:
Expand All @@ -70,8 +72,6 @@ Calculate the winner using Black's method:

Candidate 2 is the Condorcet winner, and wins under Black's method.

See [/examples](./examples) folder for more on what it can do, such as reproductions of previous research.

## Submodules and chained functions

Originally, the functions in submodules were meant to be chained together in a simple flow:
Expand Down

0 comments on commit 84cb77b

Please sign in to comment.