Split examples and user guide into separate sections #250
Labels
documentation
Improvements or additions to documentation
needs refinement
issue still needs refinement
HydroMT-Wflow version checks
main
hereKind 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
The text was updated successfully, but these errors were encountered: