Skip to content

Improve Documentation for NonlinearVerbosity #722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 4, 2025
Merged

Improve Documentation for NonlinearVerbosity #722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16a9d09
fix up docs for verbosity
jClugstor Nov 4, 2025
f746f8d
add verbosity manual to pages.md
jClugstor Nov 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/pages.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
16 changes: 4 additions & 12 deletions docs/src/basics/solve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
9 changes: 9 additions & 0 deletions docs/src/basics/verbosity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
Loading