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

deltares data argument in documentation #235

Closed shartgring closed 6 months ago

shartgring commented 6 months ago

HydroMT-Wflow version checks

Kind of issue

Docs are wrong

Location of the documentation

https://deltares.github.io/hydromt_wflow/latest/user_guide/wflow_build.html With the following text:

Another options for Deltares users is to select the deltares-data library (requires access to the Deltares P-drive). In the command lines examples below, this is done by adding either –dd or –deltares-data to the build / update command line.

Documentation problem

-dd is given as option/argument, should be --dd

Using -dd will result in hydromt thinking that a catalog with name d is added resulting in the following error:

ValueError: Catalog with name "d" not found in predefined catalogs

Suggested fix for documentation

Replace -dd with --dd in documentation

hboisgon commented 6 months ago

Good catch! Actually --dd will be deprecated soon so better also already remove this option from our docs.