Skip to content

Commit 099125d

Browse files
Merge pull request #771 from jClugstor/aliasing_API
Add alias specifier docstrings to problem type pages
2 parents f034149 + fe2fad6 commit 099125d

File tree

8 files changed

+49
-0
lines changed

8 files changed

+49
-0
lines changed

docs/src/types/bvp_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ SciMLBase.SecondOrderBVProblem
1010
`BVProblem` solutions return an `ODESolution`. For more information, see the
1111
[ODE problem definition page](@ref ode_prob) for the `ODESolution` docstring.
1212

13+
## Alias Specifier
14+
15+
```@docs
16+
SciMLBase.BVPAliasSpecifier
17+
```
18+
1319
## Example Problems
1420

1521
Example problems can be found in [DiffEqProblemLibrary.jl](https://github.com/SciML/DiffEqProblemLibrary.jl/blob/master/lib/BVProblemLibrary/src/BVProblemLibrary.jl).

docs/src/types/dae_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ SciMLBase.DAEFunction
1111
SciMLBase.DAESolution
1212
```
1313

14+
## Alias Specifier
15+
16+
```@docs
17+
SciMLBase.DAEAliasSpecifier
18+
```
19+
1420
## Example Problems
1521

1622
Examples problems can be found in [DiffEqProblemLibrary.jl](https://github.com/SciML/DiffEqProblemLibrary.jl/tree/master/lib/DAEProblemLibrary).

docs/src/types/dde_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ SciMLBase.DDEFunction
1010
`DDEProblem` solutions return an `ODESolution`. For more information, see the
1111
[ODE problem definition page](@ref ode_prob) for the `ODESolution` docstring.
1212

13+
## Alias Specifier
14+
15+
```@docs
16+
SciMLBase.DDEAliasSpecifier
17+
```
18+
1319
## Example Problems
1420

1521
Example problems can be found in [DiffEqProblemLibrary.jl](https://github.com/SciML/DiffEqProblemLibrary.jl/blob/master/lib/DDEProblemLibrary/src/DDEProblemLibrary.jl).

docs/src/types/ode_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ SciMLBase.ODEFunction
1111
SciMLBase.ODESolution
1212
```
1313

14+
## ODE Alias Specifier
15+
16+
```@docs
17+
SciMLBase.ODEAliasSpecifier
18+
```
19+
1420
## Example Problems
1521

1622
Example problems can be found in [DiffEqProblemLibrary.jl](https://github.com/SciML/DiffEqProblemLibrary.jl/tree/master/lib/ODEProblemLibrary/src).

docs/src/types/rode_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,9 @@ SciMLBase.RODEFunction
1010
```@docs
1111
SciMLBase.RODESolution
1212
```
13+
14+
## Alias Specifier
15+
16+
```@docs
17+
SciMLBase.RODEAliasSpecifier
18+
```

docs/src/types/sdde_types.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,10 @@ SciMLBase.SDDEFunction
99

1010
`SDDEProblem` solutions return an `RODESolution`. For more information, see the
1111
[RODE problem definition page](@ref rode_problem) for the `RODESolution` docstring.
12+
13+
14+
## Alias Specifier
15+
16+
```@docs
17+
SciMLBase.SDDEAliasSpecifier
18+
```

docs/src/types/sde_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ SciMLBase.SDEFunction
1010
`SDEProblem` solutions return an `RODESolution`. For more information, see the
1111
[RODE problem definition page](@ref rode_problem) for the `RODESolution` docstring.
1212

13+
## Alias Specifier
14+
15+
```@docs
16+
SciMLBase.SDEAliasSpecifier
17+
```
18+
1319
## Example Problems
1420

1521
Examples problems can be found in [DiffEqProblemLibrary.jl](https://github.com/SciML/DiffEqProblemLibrary.jl/blob/master/lib/SDEProblemLibrary/src/SDEProblemLibrary.jl).

docs/src/types/steady_state_types.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,9 @@ SciMLBase.SteadyStateProblem
1414
```@docs
1515
SciMLBase.NonlinearSolution
1616
```
17+
18+
## Alias Specifier
19+
20+
```@docs
21+
SciMLBase.SteadyStateAliasSpecifier
22+
```

0 commit comments

Comments
 (0)