RVIC icon indicating copy to clipboard operation
RVIC copied to clipboard

[docs] Unit hydrograph terminology is a little confusing

Open tbohn opened this issue 7 years ago • 2 comments

The use of the term "unit hydrograph" for both the overland flow to the channel, and again for flow within the channel, appears to be confusing for new users. I think it would be possible to clear up some of the confusion by changing the name of the overland unit hydrograph from UH_BOX (which may not connote overland flow to a new user) to UH_land or something similar. Along the same lines, perhaps call the other unit hydrographs UH_channel or something similar.

Also, perhaps the presence of 2 steps, each involving different unit hydrographs, could be made clearer in the documentation by changing both the text on the readthedocs page to clearly label the 2 stages and also by numbering the stages explicitly in the left-hand menu bar.

These are just suggestions, but might help.

tbohn avatar Jan 29 '18 22:01 tbohn

@tbohn - I completely agree. Contributions to the documentation are welcome by you or other interested users.

jhamman avatar Jan 31 '18 01:01 jhamman

Sure, I can try to work on it when I have time, but I wanted to get feedback on the idea before putting any effort into it... Now the issue's on the table.

tbohn avatar Jan 31 '18 04:01 tbohn