Skip to content

Commit bb334dc

Browse files
jClugstorChrisRackauckas
authored andcommitted
fix up docs for verbosity
1 parent 3d26a9f commit bb334dc

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

docs/src/basics/solve.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,26 +38,18 @@ These are exclusively available for native `NonlinearSolve.jl` solvers.
3838
stored in the solution object. (Defaults to `Val(false)`)
3939

4040
## Verbosity Controls
41-
42-
NonlinearSolve.jl provides fine-grained control over diagnostic messages, warnings, and errors
43-
through the `verbose` keyword argument. The verbosity system allows you to control what
44-
information is displayed during the solve process. See [SciMLLogging.jl](https://docs.sciml.ai/SciMLLogging/dev/) for more details.
45-
46-
```@docs
47-
NonlinearVerbosity
48-
```
49-
41+
- `verbose::NonlinearVerbosity`: Controls the verbosity of the solver. Determines which messages get logged at what logging level.
5042
### Quick Start
5143

5244
```julia
5345
# Use a preset
54-
solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.Standard()))
46+
solve(prob, alg; verbose = SciMLLogging.Standard())
5547

5648
# Silence all messages
57-
solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.None()))
49+
solve(prob, alg; verbose = SciMLLogging.None())
5850

5951
# Maximum verbosity
60-
solve(prob, alg; verbose = NonlinearVerbosity(SciMLLogging.All()))
52+
solve(prob, alg; verbose = SciMLLogging.All())
6153

6254
# Custom configuration
6355
solve(prob, alg; verbose = NonlinearVerbosity(

docs/src/basics/verbosity.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# [Controlling Solver Verbosity](@id verbosity)
2+
3+
NonlinearSolve.jl provides fine-grained control over diagnostic messages, warnings, and errors
4+
through the `verbose` keyword argument. The verbosity system allows you to control what
5+
information is displayed during the solve process. See [SciMLLogging.jl](https://docs.sciml.ai/SciMLLogging/dev/) for more details.
6+
7+
```@docs
8+
NonlinearVerbosity
9+
```

0 commit comments

Comments
 (0)