From 16a9d09bfd31a51eacd27c5cf9d10e150966fdd9 Mon Sep 17 00:00:00 2001 From: jClugstor Date: Tue, 4 Nov 2025 13:58:25 -0500 Subject: [PATCH 1/2] fix up docs for verbosity --- docs/src/basics/solve.md | 16 ++++------------ docs/src/basics/verbosity.md | 9 +++++++++ 2 files changed, 13 insertions(+), 12 deletions(-) create mode 100644 docs/src/basics/verbosity.md diff --git a/docs/src/basics/solve.md b/docs/src/basics/solve.md index 15e967d52..8e46400f6 100644 --- a/docs/src/basics/solve.md +++ b/docs/src/basics/solve.md @@ -38,26 +38,18 @@ These are exclusively available for native `NonlinearSolve.jl` solvers. stored in the solution object. (Defaults to `Val(false)`) ## Verbosity Controls - -NonlinearSolve.jl provides fine-grained control over diagnostic messages, warnings, and errors -through the `verbose` keyword argument. The verbosity system allows you to control what -information is displayed during the solve process. See [SciMLLogging.jl](https://docs.sciml.ai/SciMLLogging/dev/) for more details. - -```@docs -NonlinearVerbosity -``` - + - `verbose::NonlinearVerbosity`: Controls the verbosity of the solver. Determines which messages get logged at what logging level. ### Quick Start ```julia # Use a preset -solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.Standard())) +solve(prob, alg; verbose = SciMLLogging.Standard()) # Silence all messages -solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.None())) +solve(prob, alg; verbose = SciMLLogging.None()) # Maximum verbosity -solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.All())) +solve(prob, alg; verbose = SciMLLogging.All()) # Custom configuration solve(prob, alg; verbose = NonlinearVerbosity( diff --git a/docs/src/basics/verbosity.md b/docs/src/basics/verbosity.md new file mode 100644 index 000000000..7f1554be8 --- /dev/null +++ b/docs/src/basics/verbosity.md @@ -0,0 +1,9 @@ +# [Controlling Solver Verbosity](@id verbosity) + +NonlinearSolve.jl provides fine-grained control over diagnostic messages, warnings, and errors +through the `verbose` keyword argument. The verbosity system allows you to control what +information is displayed during the solve process. See [SciMLLogging.jl](https://docs.sciml.ai/SciMLLogging/dev/) for more details. + +```@docs +NonlinearVerbosity +``` From f746f8d7570fc77a4ae54b7fc987fb30c73f6b71 Mon Sep 17 00:00:00 2001 From: jClugstor Date: Tue, 4 Nov 2025 14:00:11 -0500 Subject: [PATCH 2/2] add verbosity manual to pages.md --- docs/pages.jl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/pages.jl b/docs/pages.jl index 23e449bba..a38a2e4ae 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -22,7 +22,8 @@ pages = [ "basics/termination_condition.md", "basics/diagnostics_api.md", "basics/sparsity_detection.md", - "basics/faq.md" + "basics/faq.md", + "basics/verbosity.md" ], "Solver Summaries and Recommendations" => Any[ "solvers/nonlinear_system_solvers.md",