From effaa64011e5eb30dfea5537a17e2eebb55dd5e2 Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Thu, 26 Oct 2023 10:41:09 -0400 Subject: [PATCH] Fix docs --- docs/src/basics/solve.md | 2 +- docs/src/tutorials/small_compile.md | 2 +- src/broyden.jl | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/src/basics/solve.md b/docs/src/basics/solve.md index 8f153dbd6..8e33ed933 100644 --- a/docs/src/basics/solve.md +++ b/docs/src/basics/solve.md @@ -1,5 +1,5 @@ # [Common Solver Options (Solve Keyword Arguments)](@id solver_options) ```@docs -solve(prob::SciMLBase.NonlinearProblem,args...;kwargs...) +solve(prob::SciMLBase.NonlinearProblem, args...; kwargs...) ``` diff --git a/docs/src/tutorials/small_compile.md b/docs/src/tutorials/small_compile.md index 4f4c56b14..c5a40ee05 100644 --- a/docs/src/tutorials/small_compile.md +++ b/docs/src/tutorials/small_compile.md @@ -1,4 +1,4 @@ -# Faster Startup and and Static Compilation +# [Faster Startup and and Static Compilation](@id fast_startup) In many instances one may want a very lightweight version of NonlinearSolve.jl. For this case there exists the solver package SimpleNonlinearSolve.jl. SimpleNonlinearSolve.jl solvers all satisfy the diff --git a/src/broyden.jl b/src/broyden.jl index 6be29a77b..7eb818459 100644 --- a/src/broyden.jl +++ b/src/broyden.jl @@ -12,7 +12,7 @@ An implementation of `Broyden` with reseting and line search. - `linesearch`: the line search algorithm to use. Defaults to [`LineSearch()`](@ref), which means that no line search is performed. Algorithms from `LineSearches.jl` can be used here directly, and they will be converted to the correct `LineSearch`. It is - recommended to use [LiFukushimaLineSearchCache](@ref) -- a derivative free linesearch + recommended to use [LiFukushimaLineSearch](@ref) -- a derivative free linesearch specifically designed for Broyden's method. """ @concrete struct GeneralBroyden <: AbstractNewtonAlgorithm{false, Nothing}