Closed cdonnay closed 9 months ago
If you run poetry run mkdocs serve
it should give you a live-updating preview of all changes as you make them.
re: #2, some social choice theory documentation seems like it'll be important and a great idea. Others can weigh in but I personally think it'd be nice to have it all in one place so it can crosslink easily/etc.
(e.g. add some markdown pages to docs/ and update mkdocs.yml accordingly, those docs can then easily reference the API documentation and vice versa)
I fixed some lingering capitalization errors and did some formatting on the API page:
round_num
and unset
from the documentation as users do not need to see these helper functions.I'll make the social choice documentation in a different PR, so this one is all set to go.
Also agree that it would be smart to have both the theory and code documentation in the same place! @cdonnay let's put our heads together to divvy up that work
Tries to make the documentation clearer and more consistent across the API page.
@jamesturk @drdeford @jgibson517 @jennjwang @ziglaser