Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
avik-pal committed Oct 26, 2023
1 parent 191a237 commit 214be06
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 5 deletions.
2 changes: 0 additions & 2 deletions docs/src/basics/NonlinearProblem.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ the sign of `f(t_0)` is opposite the sign of `f(t_f)`, thus guaranteeing a root
interval.

!!! note

Interval rootfinding problems allow for `f` to return an array, in which case the interval
rootfinding problem is interpreted as finding the first `t` such that any of the components
of the array hit zero.
Expand All @@ -32,7 +31,6 @@ that `f(u) = 0`, the `NonlinearProblem` does not have a preferred solution, whil
ODE `u' = f(u,t)`.

!!! warn

Most solvers for `SteadyStateProblem` do not guarantee the preferred solution and
instead will solve for some `u` in the set of solutions. The documentation of the
nonlinear solvers will note if they return the preferred solution.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/basics/solve.md
Original file line number Diff line number Diff line change
@@ -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...)
```
2 changes: 1 addition & 1 deletion docs/src/tutorials/small_compile.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/broyden.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit 214be06

Please sign in to comment.