Enhance docs and add examples
Restioson opened this issue · 3 comments
Restioson commented
We should rewrite docs for existing code, adding it where there is none, and add examples. Even private functions should be documented -- this is so that contributors will be able to easily find out how to use something.
Gegy commented
Maybe a bit out of context, but should relate. Should we make a contributing doc for anyone (and ourselves) who needs to review this project's coding standards?
Restioson commented
Going forward from now, let's write docs and examples on non trivial functions (not getters and really simple things). @gegy1000, agree or disagree?