Skip to content

Commit d7e999c

Browse files
committed
Update documentation to use ModelingToolkit's enhanced problem constructor docstrings
Modified docs/src/API/problems.md to reference ModelingToolkit's exported problem constructors directly instead of always using SciMLBase references. This ensures that the generated documentation shows ModelingToolkit's enhanced docstrings that include references to both MTK's problem building documentation and the relevant solver documentation. Updated references: - ODEProblem, SDEProblem, JumpProblem → Now use MTK's enhanced docstrings - NonlinearProblem, OptimizationProblem, SteadyStateProblem → Now use MTK's enhanced docstrings - IntervalNonlinearProblem, DiscreteProblem, ImplicitDiscreteProblem → Now use MTK's enhanced docstrings Non-exported types (DAEProblem, DDEProblem, BVProblem, LinearProblem) still reference SciMLBase versions, but users calling these through ModelingToolkit will see the enhanced docstrings in the REPL help system. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 2f00a37 commit d7e999c

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/src/API/problems.md

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

1515
```@docs
1616
SciMLBase.ODEFunction
17-
SciMLBase.ODEProblem
17+
ODEProblem
1818
SciMLBase.DAEFunction
1919
SciMLBase.DAEProblem
2020
SciMLBase.SDEFunction
21-
SciMLBase.SDEProblem
21+
SDEProblem
2222
SciMLBase.DDEFunction
2323
SciMLBase.DDEProblem
2424
SciMLBase.SDDEFunction
2525
SciMLBase.SDDEProblem
26-
JumpProcesses.JumpProblem
26+
JumpProblem
2727
SciMLBase.BVProblem
28-
SciMLBase.DiscreteProblem
29-
SciMLBase.ImplicitDiscreteProblem
28+
DiscreteProblem
29+
ImplicitDiscreteProblem
3030
```
3131

3232
## Linear and Nonlinear systems
3333

3434
```@docs
3535
SciMLBase.NonlinearFunction
36-
SciMLBase.NonlinearProblem
36+
NonlinearProblem
3737
SciMLBase.SCCNonlinearProblem
3838
SciMLBase.NonlinearLeastSquaresProblem
39-
SciMLBase.SteadyStateProblem
39+
SteadyStateProblem
4040
SciMLBase.IntervalNonlinearFunction
41-
SciMLBase.IntervalNonlinearProblem
41+
IntervalNonlinearProblem
4242
ModelingToolkit.HomotopyContinuationProblem
4343
SciMLBase.HomotopyNonlinearFunction
4444
SciMLBase.LinearProblem
@@ -48,7 +48,7 @@ SciMLBase.LinearProblem
4848

4949
```@docs
5050
SciMLBase.OptimizationFunction
51-
SciMLBase.OptimizationProblem
51+
OptimizationProblem
5252
SciMLBase.ODEInputFunction
5353
ModelingToolkit.JuMPDynamicOptProblem
5454
ModelingToolkit.InfiniteOptDynamicOptProblem

0 commit comments

Comments
 (0)