Drop deprecated things

Author: avik-pal

Project.toml

@@ -1,7 +1,7 @@
 name = "NonlinearSolve"
 uuid = "8913a72c-1f9b-4ce2-8d82-65094dcecaec"
 authors = ["SciML"]
-version = "2.10.0"
+version = "3.0.0"
 
 [deps]
 ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"
@@ -72,7 +72,7 @@ Reexport = "0.2, 1"
 SafeTestsets = "0.1"
 SciMLBase = "2.9"
 SciMLOperators = "0.3"
-SimpleNonlinearSolve = "0.1.23"
+SimpleNonlinearSolve = "1"
 SparseArrays = "<0.0.1, 1"
 SparseDiffTools = "2.14"
 StableRNGs = "1"

docs/Project.toml

@@ -30,7 +30,7 @@ NonlinearSolve = "1, 2"
 NonlinearSolveMINPACK = "0.1"
 SciMLBase = "2.4"
 SciMLNLSolve = "0.1"
-SimpleNonlinearSolve = "0.1.5, 1"
+SimpleNonlinearSolve = "1"
 StaticArrays = "1"
 SteadyStateDiffEq = "1.10, 2"
 Sundials = "4.11"

docs/pages.jl

@@ -25,4 +25,5 @@ pages = ["index.md",
         "api/nlsolve.md",
         "api/sundials.md",
         "api/steadystatediffeq.md"],
+    "Release Notes" => "release_notes.md",
 ]

docs/src/api/nonlinearsolve.md

@@ -9,8 +9,8 @@ NewtonRaphson
 TrustRegion
 PseudoTransient
 DFSane
-GeneralBroyden
-GeneralKlement
+Broyden
+Klement
 ```
 
 ## Polyalgorithms

docs/src/api/simplenonlinearsolve.md

@@ -18,7 +18,7 @@ Brent
 
 ### General Methods
 
-These methods are suited for any general nonlinear root-finding problem , i.e. `NonlinearProblem`.
+These methods are suited for any general nonlinear root-finding problem, i.e. `NonlinearProblem`.
 
 ```@docs
 SimpleNewtonRaphson

docs/src/api/steadystatediffeq.md

@@ -17,4 +17,5 @@ These methods can be used independently of the rest of NonlinearSolve.jl
 
 ```@docs
 DynamicSS
+SSRootfind
 ```

docs/src/basics/TerminationCondition.md

@@ -63,14 +63,3 @@ DiffEqBase.NonlinearSafeTerminationReturnCode.Failure
 DiffEqBase.NonlinearSafeTerminationReturnCode.PatienceTermination
 DiffEqBase.NonlinearSafeTerminationReturnCode.ProtectiveTermination
 ```
-
-## [Deprecated] Termination Condition API
-
-!!! warning
-    
-    This is deprecated. Currently only parts of `SimpleNonlinearSolve` uses this API. That
-    will also be phased out soon!
-
-```@docs
-NLSolveTerminationCondition
-```

docs/src/basics/solve.md

@@ -3,3 +3,31 @@
 ```@docs
 solve(prob::SciMLBase.NonlinearProblem, args...; kwargs...)
 ```
+
+## General Controls
+
+- `alias_u0::Bool`: Whether to alias the initial condition or use a copy.
+  Defaults to `false`.
+- `internal_norm::Function`: The norm used by the solver. Default depends on algorithm
+  choice.
+
+## Iteration Controls
+
+- `maxiters::Int`: The maximum number of iterations to perform. Defaults to `1000`.
+- `abstol::Number`: The absolute tolerance.
+- `reltol::Number`: The relative tolerance.
+- `termination_condition`: Termination Condition from DiffEqBase. Defaults to
+  `AbsSafeBestTerminationMode()` for `NonlinearSolve.jl` and `AbsTerminateMode()` for
+  `SimpleNonlinearSolve.jl`.
+
+## Tracing Controls
+
+These are exclusively available for native `NonlinearSolve.jl` solvers.
+
+- `show_trace`: Must be `Val(true)` or `Val(false)`. This controls whether the trace is
+  displayed to the console. (Defaults to `Val(false)`)
+- `trace_level`: Needs to be one of Trace Objects: [`TraceMinimal`](@ref),
+  [`TraceWithJacobianConditionNumber`](@ref), or [`TraceAll`](@ref). This controls the
+  level of detail of the trace. (Defaults to `TraceMinimal()`)
+- `store_trace`: Must be `Val(true)` or `Val(false)`. This controls whether the trace is
+  stored in the solution object. (Defaults to `Val(false)`)

docs/src/index.md

@@ -27,19 +27,17 @@ Pkg.add("NonlinearSolve")
 
 ## Contributing
 
-  - Please refer to the
-    [SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
-    for guidance on PRs, issues, and other matters relating to contributing to SciML.
-
-  - See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
-  - There are a few community forums:
-    
-      + The #diffeq-bridged and #sciml-bridged channels in the
-        [Julia Slack](https://julialang.org/slack/)
-      + The #diffeq-bridged and #sciml-bridged channels in the
-        [Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
-      + On the [Julia Discourse forums](https://discourse.julialang.org)
-      + See also [SciML Community page](https://sciml.ai/community/)
+- Please refer to the
+  [SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
+  for guidance on PRs, issues, and other matters relating to contributing to SciML.
+
+- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
+- There are a few community forums:
+
+  - The #diffeq-bridged and #sciml-bridged channels in the [Julia Slack](https://julialang.org/slack/)
+  - The #diffeq-bridged and #sciml-bridged channels in the [Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+  - On the [Julia Discourse forums](https://discourse.julialang.org)
+  - See also [SciML Community page](https://sciml.ai/community/)
 
 ## Reproducibility
 

docs/src/release_notes.md

@@ -0,0 +1,9 @@
+# Release Notes
+
+## Breaking Changes in NonlinearSolve.jl v3
+
+1. `GeneralBroyden` and `GeneralKlement` have been renamed to `Broyden` and `Klement`
+   respectively.
+2. Compat for `SimpleNonlinearSolve` has been bumped to `v1`.
+3. The old API to specify autodiff via `Val` and chunksize (that was deprecated in v2) has
+   been removed.