Skip to content

Commit 37ebc88

Browse files
docs: add docstrings for has_observed_with_lhs, has_parameter_dependency_with_lhs
1 parent 5c3468c commit 37ebc88

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/systems/abstractsystem.jl

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,12 @@ function SymbolicIndexingInterface.parameter_observed(sys::AbstractSystem, sym)
386386
return build_explicit_observed_function(sys, sym; param_only = true)
387387
end
388388

389-
function has_observed_with_lhs(sys, sym)
389+
"""
390+
$(TYPEDSIGNATURES)
391+
392+
Check if the system `sys` contains an observed equation with LHS `sym`.
393+
"""
394+
function has_observed_with_lhs(sys::AbstractSystem, sym)
390395
has_observed(sys) || return false
391396
if has_index_cache(sys) && (ic = get_index_cache(sys)) !== nothing
392397
return haskey(ic.observed_syms_to_timeseries, sym)
@@ -395,6 +400,11 @@ function has_observed_with_lhs(sys, sym)
395400
end
396401
end
397402

403+
"""
404+
$(TYPEDSIGNATURES)
405+
406+
Check if the system `sys` contains a parameter dependency equation with LHS `sym`.
407+
"""
398408
function has_parameter_dependency_with_lhs(sys, sym)
399409
has_parameter_dependencies(sys) || return false
400410
if has_index_cache(sys) && (ic = get_index_cache(sys)) !== nothing

0 commit comments

Comments
 (0)