Comments adressed

Deltares · Jul 23, 2024 · f1045ee · f1045ee
1 parent d0abc09
commit f1045ee
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 8 deletions.
diff --git a/python/ribasim/ribasim/config.py b/python/ribasim/ribasim/config.py
@@ -105,7 +105,7 @@ class Solver(ChildModel):
     sparse : bool
         Whether a sparse Jacobian matrix is used, which gives a significant speedup for models with >~10 basins.
     autodiff : bool
-        Whether automatic differentiation in stead of fine difference is used to compute the Jacobian.
+        Whether automatic differentiation instead of fine difference is used to compute the Jacobian. (Optional, defaults to true)
     """
 
     algorithm: str = "QNDF"
@@ -130,14 +130,14 @@ class Verbosity(str, Enum):
 
 class Logging(ChildModel):
     """
-    Defines the logging behaviour of the core.
+    Defines the logging behavior of the core.
 
     Attributes
     ----------
     verbosity : Verbosity
         The verbosity of the logging: debug/info/warn/error (Optional, defaults to info)
     timing : Bool
-        Enable timings.
+        Enable timings (Optional, defaults to False)
     """
 
     verbosity: Verbosity = Verbosity.info

diff --git a/python/ribasim/ribasim/geometry/edge.py b/python/ribasim/ribasim/geometry/edge.py
@@ -63,8 +63,7 @@ def add(
         to_node: NodeData
             A node indexed by its node ID, e.g. `model.linear_resistance[1]`
         geometry : LineString | MultiLineString | None
-            The geometry of a line. If not supplied, the geometry is inferred as a
-            straight line between the edge ends.
+            The geometry of a line. If not supplied, it creates a straight line between the nodes.
         name : str
             An optional name for the edge.
         subnetwork_id : int | None

diff --git a/python/ribasim/ribasim/model.py b/python/ribasim/ribasim/model.py
@@ -185,7 +185,7 @@ def set_crs(self, crs: str) -> None:
         Parameters
         ----------
         crs : str
-            Coordinate reference system
+            Coordinate reference system, like "EPSG:4326" for WGS84 latitude longitude.
         """
         self._apply_crs_function("set_crs", crs)
 
@@ -402,9 +402,9 @@ def to_xugrid(self, add_flow: bool = False, add_allocation: bool = False):
         Parameters
         ----------
         add_flow : bool
-            add flow results
+            add flow results (Optional, defaults to False)
         add_allocation : bool
-            add allocation results
+            add allocation results (Optional, defaults to False)
         """
 
         if add_flow and add_allocation: