diff --git a/docs/pages.jl b/docs/pages.jl index 14f391d36..6d9b5d0e2 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -7,6 +7,7 @@ pages = ["index.md", "basics/NonlinearFunctions.md", "basics/solve.md", "basics/NonlinearSolution.md", + "basics/TerminationCondition.md", "basics/FAQ.md"], "Solver Summaries and Recommendations" => Any["solvers/NonlinearSystemSolvers.md", "solvers/BracketingSolvers.md", diff --git a/docs/src/basics/TerminationCondition.md b/docs/src/basics/TerminationCondition.md new file mode 100644 index 000000000..cd780b997 --- /dev/null +++ b/docs/src/basics/TerminationCondition.md @@ -0,0 +1,11 @@ +# Termination Conditions + +Provides a API to specify termination conditions for [`NonLinearProblem`](@ref) and +[`SteadyStateProblem`](@ref). For details on the various termination modes, i.e., +NLSolveTerminationMode, see the documentation for [`NLSolveTerminationCondition`](@ref). + +## Termination Condition API + +```@docs +NLSolveTerminationCondition +```