Write documentation - Githubissues

daffidwilde / matching

A package for solving matching games

https://daffidwilde.github.io/matching/

MIT License

150 stars 42 forks source link

Closed daffidwilde closed 4 years ago

daffidwilde commented 5 years ago

A list of things that need doing to the docs

[x] Discussion pages
- One for each type of game
- Other packages
[x] Reference
- Autodocs
- Citing the library
- Bibliography
- Contributing
[x] Tutorials
- One for each way of creating a game
[x] How-to's:
- How to remove banned pairs (as in #68)
- How to pick optimality of solution
- How to update a matching
- How to check for stability and validity

daffidwilde commented 4 years ago

Pretty much there now. Closing and will open specific issues later.