Skip to content

Commit 8b337a8

Browse files
docs: repair strict cross-references (#4980)
Co-authored-by: ChrisRackauckas-Claude <accounts@chrisrackauckas.com>
1 parent 29f589e commit 8b337a8

22 files changed

Lines changed: 39 additions & 36 deletions

docs/src/API/variables.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -410,8 +410,9 @@ ModelingToolkit.dump_parameters
410410
## Symbolic operators
411411

412412
ModelingToolkit makes heavy use of "operators". These are custom functions that are applied
413-
to symbolic variables. The most common operator is the Differential operator, defined in
414-
Symbolics.jl.
413+
to symbolic variables. The most common operator is the
414+
[Differential operator](https://docs.sciml.ai/Symbolics/stable/manual/derivatives/), defined
415+
in Symbolics.jl.
415416

416417
ModelingToolkit also defines a plethora of custom operators.
417418

docs/src/tutorials/fmi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Following are the variables in the FMU (both states and parameters):
3535
fmu.modelDescription.modelVariables
3636
```
3737

38-
Next, [`FMIComponent`](@ref) is used to import the FMU as an MTK component. We provide the FMI
38+
Next, [`FMIComponent`](@ref ModelingToolkit.FMIComponent) is used to import the FMU as an MTK component. We provide the FMI
3939
major version as a `Val` to the constructor, along with the loaded FMU and the type as keyword
4040
arguments.
4141

lib/ModelingToolkitBase/src/problems/daeproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ end
5050
SciMLBase.DAEFunction{iip, spec}(sys::System, opts::SciMLFunctionOptions; kwargs...)
5151
5252
Public entry point that builds a `DAEFunction` directly from a pre-assembled
53-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
53+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
5454
"""
5555
function SciMLBase.DAEFunction{iip, spec}(
5656
sys::System, opts::SciMLFunctionOptions{E};

lib/ModelingToolkitBase/src/problems/ddeproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ end
1818
SciMLBase.DDEFunction{iip, spec}(sys::System, opts::SciMLFunctionOptions)
1919
2020
Public entry point that builds a `DDEFunction` directly from a pre-assembled
21-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
21+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
2222
"""
2323
function SciMLBase.DDEFunction{iip, spec}(
2424
sys::System, opts::SciMLFunctionOptions{E}

lib/ModelingToolkitBase/src/problems/discreteproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ end
1818
SciMLBase.DiscreteFunction{iip, spec}(sys::System, opts::SciMLFunctionOptions)
1919
2020
Public entry point that builds a `DiscreteFunction` directly from a pre-assembled
21-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
21+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
2222
"""
2323
function SciMLBase.DiscreteFunction{iip, spec}(
2424
sys::System, opts::SciMLFunctionOptions{E}

lib/ModelingToolkitBase/src/problems/implicitdiscreteproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ end
2020
SciMLBase.ImplicitDiscreteFunction{iip, spec}(sys::System, opts::SciMLFunctionOptions)
2121
2222
Public entry point that builds an `ImplicitDiscreteFunction` directly from a pre-assembled
23-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
23+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
2424
"""
2525
function SciMLBase.ImplicitDiscreteFunction{iip, spec}(
2626
sys::System, opts::SciMLFunctionOptions{E}

lib/ModelingToolkitBase/src/problems/intervalnonlinearproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ end
1818
SciMLBase.IntervalNonlinearFunction(sys::System, opts::SciMLFunctionOptions)
1919
2020
Public entry point that builds an `IntervalNonlinearFunction` directly from a pre-assembled
21-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
21+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
2222
"""
2323
function SciMLBase.IntervalNonlinearFunction(sys::System, opts::SciMLFunctionOptions{E}) where {E}
2424
check_complete(sys, IntervalNonlinearFunction)

lib/ModelingToolkitBase/src/problems/linearproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ end
3939
LinearFunction{iip}(sys::System, opts::SciMLFunctionOptions; kwargs...)
4040
4141
Public entry point that builds a `LinearFunction` directly from a pre-assembled
42-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
42+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
4343
"""
4444
function LinearFunction{iip}(
4545
sys::System, opts::SciMLFunctionOptions{E};

lib/ModelingToolkitBase/src/problems/nonlinearproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ end
2020
SciMLBase.NonlinearFunction{iip, spec}(sys::System, opts::SciMLFunctionOptions; kwargs...)
2121
2222
Public entry point that builds a `NonlinearFunction` directly from a pre-assembled
23-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above.
23+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above.
2424
"""
2525
function SciMLBase.NonlinearFunction{iip, spec}(
2626
sys::System, opts::SciMLFunctionOptions{E};

lib/ModelingToolkitBase/src/problems/odeproblem.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ end
4242
SciMLBase.ODEFunction{iip, spec}(sys::System, opts::SciMLFunctionOptions; kwargs...)
4343
4444
Public entry point that builds an `ODEFunction` directly from a pre-assembled
45-
[`SciMLFunctionOptions`](@ref), bypassing the `kwargs...` wrapper above. Useful for callers
45+
`SciMLFunctionOptions`, bypassing the `kwargs...` wrapper above. Useful for callers
4646
that already hold (or want to share/reuse) an options struct, since — unlike the `kwargs...`
4747
wrapper — this method does not need to re-validate or re-assemble the option set.
4848
"""

0 commit comments

Comments
 (0)