Update docstrings

Deltares · Apr 11, 2024 · 3144ef1 · 3144ef1
1 parent 25997fe
commit 3144ef1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/core/src/parameter.jl b/core/src/parameter.jl
@@ -445,8 +445,10 @@ end
 """
 node_id: node ID of the DiscreteControl node; these are not unique but repeated
     by the amount of conditions of this DiscreteControl node
-listen_node_id: the ID of the node being condition on
-variable: the name of the variable in the condition
+listen_node_id: the IDs of the nodes being condition on
+variable: the names of the variables in the condition
+weight: the weight of the variables in the condition
+look_ahead: the look ahead of variables  in the condition in seconds
 greater_than: The threshold value in the condition
 condition_value: The current value of each condition
 control_state: Dictionary: node ID => (control state, control state start)

diff --git a/core/src/read.jl b/core/src/read.jl
@@ -542,6 +542,10 @@ function Basin(db::DB, config::Config, chunk_sizes::Vector{Int})::Basin
     )
 end
 
+"""
+Parse compound variables from the compound variable table, and turn
+variables in the condition table into trivial compound variables
+"""
 function get_compound_variables(compound_variable, condition)
     listen_node_id = Vector{NodeID}[]
     variable = Vector{String}[]