Skip to content
This repository has been archived by the owner on Jan 20, 2021. It is now read-only.

Add documentation blocks for all classes and methods. #24

Open
fubhy opened this issue Nov 2, 2019 · 0 comments
Open

Add documentation blocks for all classes and methods. #24

fubhy opened this issue Nov 2, 2019 · 0 comments

Comments

@fubhy
Copy link
Contributor

fubhy commented Nov 2, 2019

As the title suggests. This is a bit of an annoying repetitive task but should be done for all our methods regardless so that the documentation generator can properly render the api docs with human readable information.

In addition to the standard parameter and short description of the methods I would really like to see usage examples (code examples) in the documentation blocks too. Especially for some of the more complicated methods. We could consider adding small excerpts that also explain the meaning of the methods a bit better if the name is not 100% clear.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant