Skip to content
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.

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

improve doc strings #38

Open
Tracked by #15
Daafip opened this issue Mar 8, 2024 · 3 comments
Open
Tracked by #15

improve doc strings #38

Daafip opened this issue Mar 8, 2024 · 3 comments

Comments

@Daafip
Copy link
Owner

Daafip commented Mar 8, 2024

No description provided.

@Daafip Daafip mentioned this issue Mar 8, 2024
4 tasks
@Daafip
Copy link
Owner Author

Daafip commented Mar 8, 2024

should resemble: https://ewatercycle.readthedocs.io/en/latest/autoapi/ewatercycle/base/forcing/index.html
with examples etc in code

@Daafip
Copy link
Owner Author

Daafip commented Mar 8, 2024

  • check code for
  • add example of use per class
  • explain thought process of implementation
  • improve formating

@Daafip Daafip changed the title improve doc strings to match Sphinx format? improve doc strings Mar 8, 2024
@Daafip
Copy link
Owner Author

Daafip commented May 29, 2024

Better description of model origins and that its most like HBV-3 from https://urn.kb.se/resolve?urn=urn:nbn:se:smhi:diva-5738,
with HBV-96 being a more modern version: https://doi.org/10.1016/S0022-1694(97)00041-3 but containing 12 parameters insetead of the 9 used here

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

No branches or pull requests

1 participant