liesel
liesel copied to clipboard
Improve API documentation
Our API documentation currently is very limited. I think it would be a good investment of our time to improve it. Specifically, that means:
- Describe not only what a class/function does, but also put it into context. For example, the
lsl.GooseModel
is currently described with the sentence "A ModelInterface for a Liesel Model". This sentence adds almost no information on top of the class name. How do you use it? What job does it do? - Classes and methods should be equipped with examples, showcasing common usage.
- Where possible, examples should be written as doctests, because that makes sure that examples stay up to date.
- We should make frequent use of the "See Also" section.
- All parameters should be documented.
- All returned values should be documented.
This issue tracks our progress with improving the documentation.
I selected what I think are the most important starting points for improved documentation.
Liesel issues
- [x] #114
- [x] #115
- [x] #116
- [x] #117
Goose issues
- [x] #113
- [x] #118
- [ ] #119
- [ ] #120
- [x] #121
- [ ] #122
- [ ] #123