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

Editorial review on user case doc #456

Merged
merged 9 commits into from
Sep 3, 2024
Merged

Conversation

petershintech
Copy link
Contributor

Issue addressed

Fixes #455 455

Explanation

Proposed fixes and revisions.

Checklist

  • Updated tests or added new tests
  • Branch is up to date with master
  • Tests & pre-commit hooks pass
  • Updated documentation if needed
  • Updated changelog.md if needed

Additional Notes (optional)

Feel free to select proposed changes when merging.

Copy link
Contributor

@verseve verseve left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this editorial review on the use cases!
Some small comments, mainly about using lowercase for wflow.

docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
docs/src/intro/use_cases.md Outdated Show resolved Hide resolved
petershintech and others added 8 commits September 4, 2024 00:52
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
Co-authored-by: Willem van Verseveld <[email protected]>
@petershintech
Copy link
Contributor Author

@verseve I assumed 'Wflow' is mentioned with the capital 'W' but I might be wrong. All your suggestions were accepted. As I read other docs, I might propose similar suggestions if I can. Thanks for sharing the source code of this model.

@verseve
Copy link
Contributor

verseve commented Sep 3, 2024

@verseve I assumed 'Wflow' is mentioned with the capital 'W' but I might be wrong. All your suggestions were accepted. As I read other docs, I might propose similar suggestions if I can. Thanks for sharing the source code of this model.

Yes, the Julia package starts indeed with a capital W (naming convention of Julia packages). This package is a continuation of a Python package (https://github.com/openstreams/wflow) and then (quite some time ago) it was decided to use lowercase letters. We decided to continue with this convention (for now).

@verseve verseve merged commit 1e6cda7 into Deltares:master Sep 3, 2024
9 checks passed
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

Successfully merging this pull request may close these issues.

Fix editorial errors in use case doc
2 participants