From 894ef33c02aab28b0e9907efcae1c5085031b1d8 Mon Sep 17 00:00:00 2001
From: Takuya Iwanaga <takuyai@gmail.com>
Date: Tue, 31 Dec 2024 17:18:33 +1100
Subject: [PATCH] Docstring updates

---
 src/Nodes/Node.jl | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/src/Nodes/Node.jl b/src/Nodes/Node.jl
index 74c7167..f05db39 100644
--- a/src/Nodes/Node.jl
+++ b/src/Nodes/Node.jl
@@ -13,7 +13,11 @@ Base.@kwdef mutable struct GenericNode{A<:AbstractFloat} <: NetworkNode
 end
 
 
-"""Create node of a given type."""
+"""
+    create_node(node::Type{<:NetworkNode}, name::String, area::Float64)
+
+Create node of a given type.
+"""
 function create_node(node::Type{<:NetworkNode}, name::String, area::Float64)
     return node{Param, Float64}(; name=name, area=area)
 end
@@ -69,7 +73,11 @@ function param_info(node::NetworkNode; kwargs...)::Tuple
 end
 
 
-"""Retrieve network node_id for a given gauge (by name)."""
+"""
+    get_node_id(mg::MetaDiGraph, node_name::String)::Int64
+
+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))