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

Clarify Node Usage with Allocation Layer in Documentation #2162

Open
Fati-Mon opened this issue Mar 19, 2025 · 0 comments
Open

Clarify Node Usage with Allocation Layer in Documentation #2162

Fati-Mon opened this issue Mar 19, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Fati-Mon
Copy link
Collaborator

What
It is necessary to clearly specify which nodes are only applicable when the allocation layer is enabled.

Why
The current documentation does not clearly address this distinction. While it’s briefly mentioned in the 'Usage' section, it may not be easily understood by the user. Additionally, the mention of user_demand, which can be used with or without allocation, might lead to confusion.

How
Include additional clarification under the 'Nodes' sections for Flow and Level Demand. Consider adding an asterisk in the Validation table as well, to avoid the impression that these two nodes can be used regardless of whether the allocation layer is on or off.

@Fati-Mon Fati-Mon added the documentation Improvements or additions to documentation label Mar 19, 2025
@github-project-automation github-project-automation bot moved this to To do in Ribasim Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: To do
Development

No branches or pull requests

1 participant