New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation #20

Open

3 of 6 tasks

dbrakenhoff opened this issue Aug 17, 2021 · 0 comments

Assignees

Labels

Collaborator

dbrakenhoff commented Aug 17, 2021 •

edited by rubencalje

I added documentation, available via rtd. There are quite some improvements to be made:

Theres a mix of Dutch and English in some docstrings. We should probably pick one and apply everywhere.
Check if all functions have a docstring
Add introduction to index.rst
Add more info on dependencies and nlmod usage in getting_started.rst
Improve notebook titles for examples section in documentation
Maybe reorganize API-docs into sections instead of one long page

dbrakenhoff added the documentation label

bdestombe self-assigned this

dbrakenhoff self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment