Skip to content

Commit 2f00a37

Browse files
committed
Update docstrings to reference ModelingToolkit's own documentation
Instead of only referencing generic solver documentation, the docstrings now point to ModelingToolkit's own problem building documentation as the primary reference, with solver-specific docs as secondary references. This provides better context for MTK-specific features and workflows while still pointing users to the underlying solver documentation for advanced options. All problem constructor docstrings now reference: 1. ModelingToolkit.jl problem building documentation (primary) 2. Relevant solver documentation (secondary) 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 7f6e858 commit 2f00a37

File tree

9 files changed

+18
-9
lines changed

9 files changed

+18
-9
lines changed

src/problems/bvproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Construct a `BVProblem` from a ModelingToolkit `System` for boundary value probl
77
88
Beyond the arguments listed below, this constructor accepts all keyword arguments
99
supported by the DifferentialEquations.jl `solve` function. For a complete list
10-
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
10+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
11+
and the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
1112
1213
## Arguments
1314
- `sys::System`: The ModelingToolkit system to convert (with boundary conditions)

src/problems/daeproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ Construct a `DAEProblem` from a ModelingToolkit `System` for differential-algebr
6868
6969
Beyond the arguments listed below, this constructor accepts all keyword arguments
7070
supported by the DifferentialEquations.jl `solve` function. For a complete list
71-
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
71+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
72+
and the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
7273
7374
## Arguments
7475
- `sys::System`: The ModelingToolkit system to convert (differential-algebraic system)

src/problems/ddeproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ Construct a `DDEProblem` from a ModelingToolkit `System` for delay differential
4747
4848
Beyond the arguments listed below, this constructor accepts all keyword arguments
4949
supported by the DifferentialEquations.jl `solve` function. For a complete list
50-
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
50+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
51+
and the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
5152
5253
## Arguments
5354
- `sys::System`: The ModelingToolkit system to convert (must contain delay equations)

src/problems/jumpproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ Construct a `JumpProblem` from a ModelingToolkit `System` for jump processes.
77
88
Beyond the arguments listed below, this constructor accepts all keyword arguments
99
supported by the DifferentialEquations.jl `solve` function. For a complete list
10-
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
10+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
11+
and the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
1112
1213
## Arguments
1314
- `sys::System`: The ModelingToolkit system to convert (must contain jump processes)

src/problems/linearproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ Construct a `LinearProblem` from a ModelingToolkit `System` for linear systems.
1515
1616
Beyond the arguments listed below, this constructor accepts all keyword arguments
1717
supported by the LinearSolve.jl `solve` function. For a complete list
18-
and detailed descriptions, see the [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
18+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
19+
and the [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
1920
2021
## Arguments
2122
- `sys::System`: The ModelingToolkit system to convert (linear system)

src/problems/nonlinearproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ Construct a `NonlinearProblem` from a ModelingToolkit `System` for nonlinear equ
6363
6464
Beyond the arguments listed below, this constructor accepts all keyword arguments
6565
supported by the NonlinearSolve.jl `solve` function. For a complete list
66-
and detailed descriptions, see the [NonlinearSolve.jl documentation](https://docs.sciml.ai/NonlinearSolve/stable/).
66+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
67+
and the [NonlinearSolve.jl documentation](https://docs.sciml.ai/NonlinearSolve/stable/).
6768
6869
## Arguments
6970
- `sys::System`: The ModelingToolkit system to convert (nonlinear system)

src/problems/odeproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ Construct an `ODEProblem` from a ModelingToolkit `System`.
7878
7979
Beyond the arguments listed below, this constructor accepts all keyword arguments
8080
supported by the DifferentialEquations.jl `solve` function. For a complete list
81-
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
81+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
82+
and the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
8283
8384
## Arguments
8485
- `sys::System`: The ModelingToolkit system to convert

src/problems/optimizationproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@ Construct an `OptimizationProblem` from a ModelingToolkit `System` for optimizat
9797
9898
Beyond the arguments listed below, this constructor accepts all keyword arguments
9999
supported by the Optimization.jl `solve` function. For a complete list
100-
and detailed descriptions, see the [Optimization.jl documentation](https://docs.sciml.ai/Optimization/stable/).
100+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
101+
and the [Optimization.jl documentation](https://docs.sciml.ai/Optimization/stable/).
101102
102103
## Arguments
103104
- `sys::System`: The ModelingToolkit system to convert (optimization system with cost and constraints)

src/problems/sdeproblem.jl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@ Construct an `SDEProblem` from a ModelingToolkit `System` with noise.
7373
7474
Beyond the arguments listed below, this constructor accepts all keyword arguments
7575
supported by the DifferentialEquations.jl `solve` function. For a complete list
76-
and detailed descriptions, see the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
76+
and detailed descriptions, see the [ModelingToolkit.jl problem building documentation](https://docs.sciml.ai/ModelingToolkit/stable/API/problems/)
77+
and the [DifferentialEquations.jl solve documentation](https://docs.sciml.ai/DiffEqDocs/stable/basics/common_solver_opts/).
7778
7879
## Arguments
7980
- `sys::System`: The ModelingToolkit system to convert (must contain noise equations)

0 commit comments

Comments
 (0)