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

[docs] Unit hydrograph terminology is a little confusing #108

Open
tbohn opened this issue Jan 29, 2018 · 2 comments
Open

[docs] Unit hydrograph terminology is a little confusing #108

tbohn opened this issue Jan 29, 2018 · 2 comments

Comments

@tbohn
Copy link

tbohn commented Jan 29, 2018

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.

@jhamman
Copy link
Member

jhamman commented Jan 31, 2018

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

@tbohn
Copy link
Author

tbohn commented Jan 31, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants