Skip to content

Commit 3032d2f

Browse files
docs: add docstring for expand_connections
1 parent 7e7b2b4 commit 3032d2f

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/systems/connectors.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -860,6 +860,12 @@ function expand_variable_connections(sys::AbstractSystem; ignored_variables = no
860860
return sys
861861
end
862862

863+
"""
864+
function expand_connections(sys::AbstractSystem)
865+
866+
Given a hierarchical system with [`connect`](@ref) equations, expand the connection
867+
equations and return the new system.
868+
"""
863869
function expand_connections(sys::AbstractSystem;
864870
debug = false, tol = 1e-10, scalarize = true)
865871
sys = remove_analysis_points(sys)

0 commit comments

Comments
 (0)