Skip to content

Commit 5c31d08

Browse files
committed
Doc string
1 parent 9814cce commit 5c31d08

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/systems/abstractsystem.jl

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,13 @@ independent_variables(sys::AbstractTimeIndependentSystem) = []
163163
independent_variables(sys::AbstractMultivariateSystem) = getfield(sys, :ivs)
164164

165165
iscomplete(sys::AbstractSystem) = isdefined(sys, :complete) && getfield(sys, :complete)
166+
167+
"""
168+
$(TYPEDSIGNATURES)
169+
170+
Mark a system as completed. If a system is complete, the system will no longer
171+
namespace its subsystems or variables, i.e. `isequal(complete(sys).v.i, v.i)`.
172+
"""
166173
function complete(sys::AbstractSystem)
167174
isdefined(sys, :complete) ? (@set! sys.complete = true) : sys
168175
end

0 commit comments

Comments
 (0)