From 9f4e9eacd3de0d23a849e7e720d9637533686be5 Mon Sep 17 00:00:00 2001 From: ChrisRackauckas-Claude Date: Sat, 11 Jul 2026 01:49:18 -0400 Subject: [PATCH 1/2] Update QA SciMLTesting compat Co-Authored-By: Chris Rackauckas --- Project.toml | 2 +- test/qa/Project.toml | 5 +---- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/Project.toml b/Project.toml index 4614bf2..e090134 100644 --- a/Project.toml +++ b/Project.toml @@ -9,7 +9,7 @@ Aqua = "0.8" JET = "0.9, 0.10, 0.11" LinearAlgebra = "1.10" SafeTestsets = "0.1" -SciMLTesting = "1.6" +SciMLTesting = "2.1" Statistics = "1.10" Test = "1.10" julia = "1.10" diff --git a/test/qa/Project.toml b/test/qa/Project.toml index 11dcdf2..769851f 100644 --- a/test/qa/Project.toml +++ b/test/qa/Project.toml @@ -8,15 +8,12 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" SurrogatesBase = "89f642e6-4179-4274-8202-c11f4bd9a72c" Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" -[sources] -SurrogatesBase = {path = "../.."} - [compat] Aqua = "0.8" JET = "0.9, 0.10, 0.11" LinearAlgebra = "1.10" SafeTestsets = "0.1" -SciMLTesting = "1.6" +SciMLTesting = "2.1" Statistics = "1.10" Test = "1.10" julia = "1.10" From c72fc1a43f078765a9b4b475e638fad1bc02fadd Mon Sep 17 00:00:00 2001 From: ChrisRackauckas-Claude Date: Sat, 11 Jul 2026 07:14:29 -0400 Subject: [PATCH 2/2] Use shared API docs QA Co-Authored-By: Chris Rackauckas --- test/qa/qa.jl | 41 +---------------------------------------- 1 file changed, 1 insertion(+), 40 deletions(-) diff --git a/test/qa/qa.jl b/test/qa/qa.jl index 314e9d2..5cf10a7 100644 --- a/test/qa/qa.jl +++ b/test/qa/qa.jl @@ -5,46 +5,7 @@ using LinearAlgebra using Test import Statistics -run_qa(SurrogatesBase; explicit_imports = true) - -function documented_api_names() - api_path = joinpath(@__DIR__, "..", "..", "docs", "src", "api.md") - prefix = string(nameof(SurrogatesBase), ".") - documented_names = Symbol[] - - for line in eachline(api_path) - stripped = strip(line) - startswith(stripped, prefix) || continue - push!(documented_names, Symbol(stripped[(lastindex(prefix) + 1):end])) - end - - return sort!(unique(documented_names)) -end - -function has_source_docstring(mod::Module, name::Symbol) - doc = Docs.doc(getfield(mod, name)) - doc === nothing && return false - - return !occursin("No documentation found", sprint(show, MIME("text/plain"), doc)) -end - -@testset "public API documentation coverage" begin - public_names = sort!( - setdiff( - names(SurrogatesBase; all = false, imported = false), - [nameof(SurrogatesBase)] - ) - ) - - missing_docstrings = [ - name for name in public_names - if !has_source_docstring(SurrogatesBase, name) - ] - missing_docs_entries = setdiff(public_names, documented_api_names()) - - @test missing_docstrings == Symbol[] - @test missing_docs_entries == Symbol[] -end +run_qa(SurrogatesBase; explicit_imports = true, api_docs_kwargs = (; rendered = true)) # JET.report_call type-stability analysis of concrete user-defined surrogates. # This goes beyond run_qa's package-level JET.test_package: it checks that the