Skip to content

Commit 1ce5f01

Browse files
authored
Remove OptimizationFunction's @ref link from BVPFunction docstring
When this docstring is used in DiffEqDocs.jl, the `[...](@ref)` causes the build to fail because `OptimizationFunction`'s docstring is hosted under Optimization.jl and not DiffEqDocs.jl. This can probably be solved by using DocumenterInterlinks.jl or something and using an `[...](@extref)`, but as a quick fix, a simple un-linked name of the type, leaving the user to search online seems sufficient.
1 parent 5f0d0a6 commit 1ce5f01

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/scimlfunctions.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2261,7 +2261,7 @@ All of the remaining functions are optional for improving or accelerating
22612261
the usage of `f` and `bc`. These include:
22622262
22632263
- `cost(u, p)`: the target to be minimized, similar with the `cost` function
2264-
in [`OptimizationFunction`](@ref). This is used to define the objective function
2264+
in `OptimizationFunction`. This is used to define the objective function
22652265
of the BVP, which can be minimized by optimization solvers.
22662266
- `equality(res, u, t)`: equality constraints functions for the BVP.
22672267
- `inequality(res, u, t)`: inequality constraints functions for the BVP.

0 commit comments

Comments
 (0)