mggg / VoteKit

A Swiss Army Knife for computational social choice research
https://votekit.readthedocs.io/en/latest/
MIT License
10 stars 12 forks source link

Adding to_dict() to election state class #107

Closed jgibson517 closed 9 months ago

jgibson517 commented 9 months ago
jgibson517 commented 9 months ago

Currently saving output ties as sets, so that the dictionary is not serializable with saving to JSON :/

jgibson517 commented 9 months ago

@cdonnay I changed some of the methods names in outcome class what do you think? // want to make sure any tutorials reflect the updated names!

jamesturk commented 9 months ago

It's probably a good idea to start maintaining a changelog.md in the docs so that people (including the core team, because you will forget) can figure out what changed in a given version and how to update their code.

https://keepachangelog.com/en/1.1.0/ has good guidelines, and pretty much any package you're using (pandas, python itself) have solid examples. You typically want to at least list breaking changes clearly, while documenting bugfixes and additions well is useful too.