Skip to content

Commit 613a9b4

Browse files
docs: improve docstring for InitializationProblem
1 parent bf24fdf commit 613a9b4

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/problems/initializationproblem.jl

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
struct InitializationProblem{iip, specialization} end
22

3-
"""
4-
```julia
5-
InitializationProblem{iip}(sys::AbstractSystem, t, op;
6-
version = nothing, tgrad = false,
7-
jac = false,
8-
checkbounds = false, sparse = false,
9-
simplify = false,
10-
linenumbers = true, parallel = SerialForm(),
11-
initialization_eqs = [],
12-
fully_determined = false,
13-
kwargs...) where {iip}
14-
```
15-
16-
Generates a NonlinearProblem or NonlinearLeastSquaresProblem from a System
17-
which represents the initialization, i.e. the calculation of the consistent
18-
initial conditions for the given DAE.
19-
"""
3+
@doc """
4+
InitializationProblem(sys::AbstractSystem, t, op = Dict(); kwargs...)
5+
InitializationProblem{iip}(sys::AbstractSystem, t, op = Dict(); kwargs...)
6+
InitializationProblem{iip, specialize}(sys::AbstractSystem, t, op = Dict(); kwargs...)
7+
8+
Generate a `NonlinearProblem`, `SCCNonlinearProblem` or `NonlinearLeastSquaresProblem` to
9+
represent a consistent initialization of `sys` given the initial time `t` and operating
10+
point `op`. The initial time can be `nothing` for time-independent systems.
11+
12+
# Keyword arguments
13+
14+
$INITIALIZEPROB_KWARGS
15+
$INTERNAL_INITIALIZEPROB_KWARGS
16+
17+
All other keyword arguments are forwarded to the wrapped nonlinear problem constructor.
18+
""" InitializationProblem
19+
2020
@fallback_iip_specialize function InitializationProblem{iip, specialize}(
2121
sys::AbstractSystem,
2222
t, op = Dict();

0 commit comments

Comments
 (0)