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

Split examples and user guide into separate sections #250

Open
1 task done
JoostBuitink opened this issue Mar 4, 2024 · 0 comments
Open
1 task done

Split examples and user guide into separate sections #250

JoostBuitink opened this issue Mar 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation needs refinement issue still needs refinement

Comments

@JoostBuitink
Copy link
Collaborator

HydroMT-Wflow version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Kind of issue

Docs are unclear

Location of the documentation

No response

Documentation problem

Currently, information and examples are mixed. This limits the current docs to include more information in a user-friendly way. For example, information in the pedo-transfer functions is lacking, information on the mapping tables is hidden through .csv files (and will be more hidden once #249 is merged). It would be nice if we have more information in the docs about the underlying assumptions and calculations that we do.

The current docstrings would be one place to put this information, but I think it would make the code too messy (and perhaps not too easy to find). By splitting the examples and user guide into separate sections would give more space to include this information. This would also create space to put more information on the LAI pre-processing (#157) and the dependencies between the methods (#125).

Suggested fix for documentation

No response

@JoostBuitink JoostBuitink added documentation Improvements or additions to documentation needs refinement issue still needs refinement labels Mar 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs refinement issue still needs refinement
Projects
None yet
Development

No branches or pull requests

1 participant