Add docstrings to be picked up by docs

ConnectedSystems · Dec 31, 2024 · 8643d24 · 8643d24
1 parent abe6c04
commit 8643d24
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 10 deletions.
diff --git a/src/Nodes/GR4J/GR4JNode.jl b/src/Nodes/GR4J/GR4JNode.jl
@@ -209,7 +209,11 @@ function update_state!(node::GR4JNode, ts::Int64, ps, rs, q, UH1, UH2)::Nothing
     return nothing
 end
 
+"""
+    update_params!(node::GR4JNode, X1::Float64, X2::Float64, X3::Float64, X4::Float64)::Nothing
 
+Update parameters for GR4J.
+"""
 function update_params!(node::GR4JNode, X1::Float64, X2::Float64, X3::Float64, X4::Float64)::Nothing
     node.X1 = Param(X1, bounds=node.X1.bounds)
     node.X2 = Param(X2, bounds=node.X2.bounds)

diff --git a/src/Nodes/HyMod/HyModNode.jl b/src/Nodes/HyMod/HyModNode.jl
@@ -158,7 +158,11 @@ function run_hymod!(node::SimpleHyModNode, ts::Int64, P::F, PET::F, inflow::F, e
     return Q_t
 end
 
+"""
+    update_params!(node::HyModNode, Sm_max::F, B::F, alpha::F, Kf::F, Ks::F) where {F<:Float64}
 
+Update parameters for HyMod.
+"""
 function update_params!(node::HyModNode, Sm_max::F, B::F, alpha::F, Kf::F, Ks::F) where {F<:Float64}
     node.Sm_max = Param(Sm_max, bounds=node.Sm_max.bounds::Tuple)
     node.B = Param(B, bounds=node.B.bounds::Tuple)

diff --git a/src/Nodes/Node.jl b/src/Nodes/Node.jl
@@ -76,7 +76,7 @@ end
 """
     get_node_id(mg::MetaDiGraph, node_name::String)::Int64
 
-Retrieve network node_id for a given gauge (by name).
+Retrieve network `node_id` for a given gauge (by name).
 """
 function get_node_id(mg::MetaDiGraph, node_name::String)::Int64
     v = collect(MetaGraphs.filter_vertices(mg, :name, node_name))
@@ -90,7 +90,7 @@ end
 """
     get_node(sn::StreamfallNetwork, node_name::String)
 
-Retrieve node_id and node property for a specified gauge.
+Retrieve `node_id` and node property for a specified gauge.
 
 # Arguments
 - sn : Streamfall Network

diff --git a/src/Nodes/SYMHYD/SYMHYDNode.jl b/src/Nodes/SYMHYD/SYMHYDNode.jl
@@ -155,15 +155,23 @@ function update_state!(node::SYMHYDNode, ts::Int64, sm_store, gw_store, total_st
     node.quickflow[ts] = quickflow
 end
 
+"""
+    update_params!(node::GR4JNode, X1::Float64, X2::Float64, X3::Float64, X4::Float64)::Nothing
 
-function update_params!(node::SYMHYDNode, baseflow_coef::Float64, impervious_threshold::Float64,
-                        infiltration_coef::Float64,
-                        infiltration_shape::Float64,
-                        interflow_coef::Float64,
-                        pervious_fraction::Float64,
-                        risc::Float64,
-                        recharge_coef::Float64,
-                        smsc::Float64)::Nothing
+Update model parameters.
+"""
+function update_params!(
+    node::SYMHYDNode,
+    baseflow_coef::Float64,
+    impervious_threshold::Float64,
+    infiltration_coef::Float64,
+    infiltration_shape::Float64,
+    interflow_coef::Float64,
+    pervious_fraction::Float64,
+    risc::Float64,
+    recharge_coef::Float64,
+    smsc::Float64
+)::Nothing
     node.baseflow_coef = Param(baseflow_coef, bounds=node.baseflow_coef.bounds)
     node.impervious_threshold = Param(impervious_threshold, bounds=node.impervious_threshold.bounds)
     node.infiltration_coef = Param(infiltration_coef, bounds=node.infiltration_coef.bounds)