Merge pull request #98 from Deltares/fix/docu-improvements

Fix/docu improvements
Deltares · Oct 20, 2023 · 02f48ba · 02f48ba
2 parents 645d932 + 0015d61
commit 02f48ba
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -63,7 +63,7 @@ pip install git+https://github.com/Deltares/Koswat.git@v0.11.0
     1. With [Anaconda](https://www.anaconda.com/) (our recommendation):    
         ```bash
         cd C:\repos\koswat
-        conda env create -f .conf\environment.yml
+        conda env create -f .config\environment.yml
         conda activate koswat_env
         poetry install
         ```

diff --git a/docs/reference/koswat_reinforced_profile.md b/docs/reference/koswat_reinforced_profile.md
@@ -1,6 +1,6 @@
 # Reinforcement profile
 
-In koswat we consider a reinforcement profile that of a result of applying one of the multiple possible reinforcement calculations on an instance of a `KoswatProfileBase` ([Koswat dike](koswat_dike.md)).
+In koswat we consider a reinforcement profile the result of applying one of the multiple possible reinforcement calculations on an instance of a `KoswatProfileBase` ([Koswat dike](koswat_dike.md)).
 
 This chapter covers the description of a reinforcement profile and its parts.
 

diff --git a/koswat/calculations/protocols/reinforcement_profile_builder_protocol.py b/koswat/calculations/protocols/reinforcement_profile_builder_protocol.py
@@ -16,7 +16,7 @@ class ReinforcementProfileBuilderProtocol(BuilderProtocol, Protocol):
 
     def build(self) -> ReinforcementProfileProtocol:
         """
-        Builds a concrete instance of a `ReinforcementProfileProtocol` base don the required data.
+        Builds a concrete instance of a `ReinforcementProfileProtocol` based on the required data.
 
         Returns:
             ReinforcementProfileProtocol: Valid instance of a `ReinforcementProfileProtocol`.

diff --git a/koswat/koswat_handler.py b/koswat/koswat_handler.py
@@ -87,7 +87,7 @@ def run_analysis(self, analysis_file: str) -> None:
         Runs a Koswat analysis using the provided `*.ini` file `analysis_file`.
 
         Args:
-            analysis_file (str): Location of the main koswat analisis ini file.
+            analysis_file (str): Location of the main koswat analysis ini file.
         """
 
         def _as_path(ini_file: str) -> Optional[Path]: