-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature/12 add uml mermaid diagram (#15)
* initial pass at something * incorrect association * chaser * initial pass * aligning the comments
- Loading branch information
1 parent
de9d579
commit e7dc948
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
|
||
```mermaid | ||
classDiagram | ||
Choice *-- Selection | ||
Ballot *-- Contest | ||
Contest *-- Selection | ||
Choice *-- Ticket | ||
class Choice { | ||
+String name | ||
+String party | ||
+Dict ticket | ||
+String choice_type | ||
} | ||
class Selection { | ||
+Int index | ||
+String name | ||
} | ||
class Ticket { | ||
+String name | ||
+String party | ||
} | ||
class Contest { | ||
+List choices # order is important | ||
+String vote_variation # RCV, plurality | ||
+String uid # unique to election only | ||
+Float win_threshold # default = 0.5 | ||
+Int votes_allowed # defines overvote | ||
+String write_in # unimplemented | ||
+List selection # index + name | ||
} | ||
class Ballot { | ||
+List active_ggos # order is important | ||
+Dict contests # ordered by active_ggos | ||
+String ballot_status # blank or cast | ||
} | ||
``` |