Skip to content

Commit ff267e0

Browse files
committed
Fix documentation to use proper method signatures for System dispatch
Updated @docs blocks in docs/src/API/problems.md to use proper Documenter.jl method signature syntax to catch ModelingToolkit's specific method dispatches. Now using explicit method signatures like: - SciMLBase.ODEProblem(::System, ::Any, ::Any) - SciMLBase.NonlinearProblem(::System, ::Any) - SciMLBase.OptimizationProblem(::System, ::Any) This ensures that Documenter.jl will find and display ModelingToolkit's enhanced docstrings that include references to both MTK's problem building documentation and the relevant solver documentation, instead of showing the generic SciMLBase docstrings. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent d7e999c commit ff267e0

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/src/API/problems.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,41 +14,41 @@ code for a variety of such numerical problems.
1414

1515
```@docs
1616
SciMLBase.ODEFunction
17-
ODEProblem
17+
SciMLBase.ODEProblem(::System, ::Any, ::Any)
1818
SciMLBase.DAEFunction
19-
SciMLBase.DAEProblem
19+
SciMLBase.DAEProblem(::System, ::Any, ::Any)
2020
SciMLBase.SDEFunction
21-
SDEProblem
21+
SciMLBase.SDEProblem(::System, ::Any, ::Any)
2222
SciMLBase.DDEFunction
23-
SciMLBase.DDEProblem
23+
SciMLBase.DDEProblem(::System, ::Any, ::Any)
2424
SciMLBase.SDDEFunction
2525
SciMLBase.SDDEProblem
26-
JumpProblem
27-
SciMLBase.BVProblem
28-
DiscreteProblem
29-
ImplicitDiscreteProblem
26+
JumpProcesses.JumpProblem(::System, ::Any, ::Any)
27+
SciMLBase.BVProblem(::System, ::Any, ::Any)
28+
SciMLBase.DiscreteProblem
29+
SciMLBase.ImplicitDiscreteProblem
3030
```
3131

3232
## Linear and Nonlinear systems
3333

3434
```@docs
3535
SciMLBase.NonlinearFunction
36-
NonlinearProblem
36+
SciMLBase.NonlinearProblem(::System, ::Any)
3737
SciMLBase.SCCNonlinearProblem
3838
SciMLBase.NonlinearLeastSquaresProblem
39-
SteadyStateProblem
39+
DiffEqBase.SteadyStateProblem(::System, ::Any)
4040
SciMLBase.IntervalNonlinearFunction
41-
IntervalNonlinearProblem
41+
SciMLBase.IntervalNonlinearProblem
4242
ModelingToolkit.HomotopyContinuationProblem
4343
SciMLBase.HomotopyNonlinearFunction
44-
SciMLBase.LinearProblem
44+
SciMLBase.LinearProblem(::System, ::Any)
4545
```
4646

4747
## Optimization and optimal control
4848

4949
```@docs
5050
SciMLBase.OptimizationFunction
51-
OptimizationProblem
51+
SciMLBase.OptimizationProblem(::System, ::Any)
5252
SciMLBase.ODEInputFunction
5353
ModelingToolkit.JuMPDynamicOptProblem
5454
ModelingToolkit.InfiniteOptDynamicOptProblem

0 commit comments

Comments
 (0)