Deltares / hydromt_wflow

Wflow plugin for HydroMT
https://deltares.github.io/hydromt_wflow/
GNU General Public License v3.0
15 stars 13 forks source link

Split examples and user guide into separate sections #250

Open JoostBuitink opened 5 months ago

JoostBuitink commented 5 months ago

HydroMT-Wflow version checks

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 https://github.com/Deltares/hydromt_wflow/pull/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 (https://github.com/Deltares/hydromt_wflow/issues/157) and the dependencies between the methods (https://github.com/Deltares/hydromt_wflow/issues/125).

Suggested fix for documentation

No response