Skip to content

Commit 5d7d97d

Browse files
Update abstractsystem.jl
1 parent da44292 commit 5d7d97d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/systems/abstractsystem.jl

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,12 @@ end
913913
"""
914914
$(TYPEDSIGNATURES)
915915
916-
Mark a system as completed. If a system is complete, the system will no longer
916+
Mark a system as completed. A completed system is a system which is done being
917+
defined/modified and is ready for structural analysis or other transformations.
918+
This allows for analyses and optimizations to be performed which require knowing
919+
the global structure of the system.
920+
921+
One property to note is that if a system is complete, the system will no longer
917922
namespace its subsystems or variables, i.e. `isequal(complete(sys).v.i, v.i)`.
918923
"""
919924
function complete(sys::AbstractSystem; split = true)

0 commit comments

Comments
 (0)