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 #17

Open

4 of 5 tasks

mroberge opened this issue Mar 7, 2018 · 1 comment

Labels

docs

Owner

mroberge commented Mar 7, 2018 •

edited

Loading

Here is a list of things that could be improved in the documentation:

Use Napoleon to improve the readability of Google-style docstrings and code pages.
Add the version number somewhere that shows up on every page.
Collect all of the todo's in the code into a page. sphinx.ext.todo
Convert the notebook pages into pages in the manual; add to the table of contents.
Create notebooks that demonstrate different applications or typical tasks.

mroberge added the docs label

Owner Author

mroberge commented Jun 19, 2020

Demonstrate how to create a rating curve
Demonstrate how to use field_meas() to create an old rating curve for velocity or something
Demonstrate how to use the site_file() to find watershed area, correlate that with discharge.

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