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

Update setup docstings #227

Merged
merged 8 commits into from
Feb 13, 2024
Merged

Update setup docstings #227

merged 8 commits into from
Feb 13, 2024

Conversation

hboisgon
Copy link
Contributor

@hboisgon hboisgon commented Dec 14, 2023

Issue addressed

Fixes #198
Fixes #201
Fixes #225

Explanation

Update dosctrings so that requirements on data of all setup methods are more clear and in one place (less need to also check data conventions guide in hydromt core docs). Also fixed small issues.

I also removed all predefined data catalog entries so that input data argument are now all required. So for eg no more "merit_hydro" and "merit_hydro_index" in setup_basemaps.

Checklist

  • Updated tests or added new tests
  • Branch is up to date with main
  • Tests & pre-commit hooks pass
  • Updated documentation if needed

@hboisgon hboisgon self-assigned this Dec 14, 2023
@dalmijn dalmijn changed the title Udpate setup docstings Update setup docstings Feb 13, 2024
Copy link
Collaborator

@dalmijn dalmijn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@dalmijn dalmijn merged commit 695d6b9 into main Feb 13, 2024
6 checks passed
@JoostBuitink JoostBuitink deleted the docs_setup branch February 14, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants