Improve spelling and grammar in the user guide #379
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
CFBaptista
added
documentation
verseve
requested changes
Mar 25, 2024
docs/src/user_guide/model-setup.md
Outdated
|
|
||
| Example models can be found in the [Example model section](@ref sample_data). | ||
|
|
||
| ## hydroMT | ||
| [hydroMT](https://github.com/Deltares/hydromt) is a Python package, developed by Deltares, | ||
| to build and analysis hydro models. It provides a generic model api with attributes to | ||
| to build and analyze hydro models. It provides a generic model api with attributes to | ||
| access the model schematization, (dynamic) forcing data, results and states. | ||
|
|
||
| For the following Wflow models: |
There was a problem hiding this comment.
Suggested change
| For the following Wflow models: | |
| For the following wflow models: |
docs/src/user_guide/model-setup.md
Outdated
|
|
||
| Example models can be found in the [Example model section](@ref sample_data). | ||
|
|
||
| ## hydroMT | ||
| [hydroMT](https://github.com/Deltares/hydromt) is a Python package, developed by Deltares, | ||
| to build and analysis hydro models. It provides a generic model api with attributes to | ||
| to build and analyze hydro models. It provides a generic model api with attributes to | ||
| access the model schematization, (dynamic) forcing data, results and states. | ||
|
|
||
| For the following Wflow models: | ||
| - wflow\_sbm + kinematic wave | ||
| - wflow_sediment | ||
|
|
||
| the Wflow plugin [hydroMT-wflow](https://github.com/Deltares/hydromt_wflow) of hydroMT can |
There was a problem hiding this comment.
Suggested change
| the Wflow plugin [hydroMT-wflow](https://github.com/Deltares/hydromt_wflow) of hydroMT can | |
| the wflow plugin [hydroMT-wflow](https://github.com/Deltares/hydromt_wflow) of hydroMT can |
docs/src/user_guide/model-setup.md
Outdated
| access the model schematization, (dynamic) forcing data, results and states. | ||
|
|
||
| For the following Wflow models: | ||
| - wflow\_sbm + kinematic wave | ||
| - wflow_sediment | ||
|
|
||
| the Wflow plugin [hydroMT-wflow](https://github.com/Deltares/hydromt_wflow) of hydroMT can | ||
| be used to build and analyse these Wflow model types in an automated way. | ||
| be used to build and analyze these Wflow model types in an automated way. |
There was a problem hiding this comment.
Suggested change
| be used to build and analyze these Wflow model types in an automated way. | |
| be used to build and analyze these wflow model types in an automated way. |
| @@ -6,7 +6,7 @@ The filepaths that are provided in this file are relative to the location of the | |||
| or to `dir_input` and `dir_output` if they are given. | |||
|
|
|||
| ## General time info | |||
| Time information is optional. When left out, for each timestamp in the forcing NetCDF Wflow | |||
| Time information is optional. When left out, for each timestamp in the forcing netCDF Wflow | |||
There was a problem hiding this comment.
Suggested change
| Time information is optional. When left out, for each timestamp in the forcing netCDF Wflow | |
| Time information is optional. When left out, for each timestamp in the forcing netCDF wflow |
| information is left out from the TOML configuration file, the `starttime`, `endtime` and | ||
| `timestepsecs` (timestep) of the run is extracted from the NetCDF forcing file by Wflow. | ||
| `timestepsecs` (timestep) of the run is extracted from the netCDF forcing file by Wflow. |
There was a problem hiding this comment.
Suggested change
| `timestepsecs` (timestep) of the run is extracted from the netCDF forcing file by Wflow. | |
| `timestepsecs` (timestep) of the run is extracted from the netCDF forcing file by wflow. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the spelling and grammar in the User guide section of the Wflow documentation.
This resolves one of the tasks in issue #377, namely the update of the User guide section.
As I joined the team this week I have been reading the documentation in sequential order from front to back and along the way I commit languages changes.