Skip to content

Commit 1893768

Browse files
committed
Add docs
1 parent 49b5c3f commit 1893768

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/systems/abstractsystem.jl

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -846,9 +846,23 @@ end
846846

847847
iscomplete(sys::AbstractSystem) = isdefined(sys, :complete) && getfield(sys, :complete)
848848

849+
"""
850+
$(TYPEDSIGNATURES)
851+
852+
Mark a system as scheduled. It is only intended in compiler internals. A system
853+
is scheduled after tearing based simplifications where equations are converted
854+
into assignments.
855+
"""
849856
function schedule(sys::AbstractSystem)
850857
has_schedule(sys) ? sys : (@set! sys.isscheduled = true)
851858
end
859+
860+
"""
861+
$(TYPEDSIGNATURES)
862+
863+
If a system is scheduled, then changing its equations, variables, and
864+
parameters is no longer legal.
865+
"""
852866
function isscheduled(sys::AbstractSystem)
853867
if has_schedule(sys)
854868
get_schedule(sys) !== nothing

0 commit comments

Comments
 (0)