Skip to content

Commit da392df

Browse files
committed
Document parameters and full_parameters
1 parent 349e9d5 commit da392df

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

src/systems/abstractsystem.jl

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1330,9 +1330,13 @@ end
13301330
"""
13311331
$(TYPEDSIGNATURES)
13321332
1333-
Get the parameters of the system `sys` and its subsystems.
1333+
Get the standard parameters of the system `sys` and its subsystems.
13341334
1335-
See also [`@parameters`](@ref) and [`ModelingToolkit.get_ps`](@ref).
1335+
# Keyword arguments
1336+
1337+
- `initial_parameters`: Whether to include parameters for initial values of variables in the initialization system.
1338+
1339+
See also [`full_parameters`](@ref) and [`ModelingToolkit.get_ps`](@ref).
13361340
"""
13371341
function parameters(sys::AbstractSystem; initial_parameters = false)
13381342
ps = get_ps(sys)
@@ -1387,6 +1391,13 @@ function parameter_dependencies(sys::AbstractSystem)
13871391
return vcat(namespaced_deps, pdeps)
13881392
end
13891393

1394+
"""
1395+
$(TYPEDSIGNATURES)
1396+
1397+
Get all parameters of the system `sys` and its subsystems, including initial values and dependent parameters.
1398+
1399+
See also [`parameters`](@ref) and [`ModelingToolkit.get_ps`](@ref).
1400+
"""
13901401
function full_parameters(sys::AbstractSystem)
13911402
vcat(parameters(sys; initial_parameters = true), dependent_parameters(sys))
13921403
end

0 commit comments

Comments
 (0)