Use strict SciMLTesting 2.4 QA

Co-Authored-By: Chris Rackauckas <accounts@chrisrackauckas.com>

Author: ChrisRackauckas

Project.toml

@@ -49,7 +49,7 @@ QuadGK = "2.9.1"
 RecipesBase = "1.3.4"
 Reexport = "1"
 SafeTestsets = "0.1"
-SciMLTesting = "2.1"
+SciMLTesting = "2.4"
 SparseConnectivityTracer = "1"
 StableRNGs = "1"
 StaticArrays = "1.9.8"

src/DataInterpolations.jl

@@ -197,11 +197,46 @@ struct CurvefitCache{
 end
 
 """
-    Curvefit(u, t, m, p0, alg; extrapolate = false, ub = nothing, lb = nothing)
+    Curvefit(
+            u, t, model, p0, alg, box = false, lb = nothing, ub = nothing;
+            extrapolate = false
+        ) -> CurvefitCache
 
-Construct an interpolation by fitting the model `m(t, p)` to data values `u` at
-timepoints `t`, using `p0` as the initial parameter guess and `alg` as the
-optimization algorithm.
+Fit `model(t, p)` to data values `u` at sample locations `t` with Optim.jl and return the
+resulting callable interpolation. The returned interpolation evaluates `model` with the
+optimized parameters available as its `pmin` field.
+
+# Arguments
+
+- `u`: observed scalar data values.
+- `t`: sample locations corresponding to `u`.
+- `model`: callable with signature `model(t, p)`, where `p` is a parameter vector.
+- `p0`: initial parameter vector supplied to Optim.jl.
+- `alg`: Optim.jl optimization algorithm, such as `LBFGS()`.
+- `box::Bool = false`: use boxed optimization when `true`; both bounds must then be given.
+- `lb = nothing`: lower parameter bounds used when `box` is `true`.
+- `ub = nothing`: upper parameter bounds used when `box` is `true`.
+
+# Keywords
+
+- `extrapolate::Bool = false`: permit evaluation outside the range of `t`. When `false`,
+  out-of-range evaluation throws `ExtrapolationError`.
+
+# Returns
+
+- `CurvefitCache`: a callable fitted interpolation. Its `pmin` field contains the optimized
+  parameter vector.
+
+# Examples
+
+```julia
+using DataInterpolations, Optim
+
+model(t, p) = p[1] .* t .+ p[2]
+A = Curvefit([1.0, 3.0, 5.0], [0.0, 1.0, 2.0], model, [0.0, 0.0], LBFGS())
+
+A(1.5)
+```
 """
 function Curvefit()
     error("CurveFit requires loading Optim and ForwardDiff, e.g. `using Optim, ForwardDiff`")

test/Extensions/Project.toml

@@ -15,7 +15,7 @@ ForwardDiff = "1"
 LinearAlgebra = "1.10"
 Mooncake = "0.4.175, 0.5"
 SafeTestsets = "0.1"
-SciMLTesting = "2.1"
+SciMLTesting = "2.4"
 SparseConnectivityTracer = "1"
 Test = "1.10"
 Zygote = "0.6.77, 0.7"

test/qa/Project.toml

@@ -11,6 +11,6 @@ Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 AllocCheck = "0.2"
 Aqua = "0.8"
 SafeTestsets = "0.0.1, 0.1"
-SciMLTesting = "2.1"
+SciMLTesting = "2.4"
 StaticArrays = "1.9.8"
 Test = "1"

test/qa/qa.jl

@@ -2,7 +2,6 @@ using SciMLTesting, DataInterpolations, Test
 
 run_qa(
     DataInterpolations;
-    explicit_imports = true,
     ei_kwargs = (;
         # `@enumx ExtrapolationType ...` generates a submodule with dynamic includes
         # that ExplicitImports cannot statically analyze; allow it to be unanalyzable
@@ -14,5 +13,4 @@ run_qa(
         # declares them public.
         all_qualified_accesses_are_public = (; ignore = (:Dual, :derivative, :value)),
     ),
-    api_docs_kwargs = (; rendered = true),
 )