From 50d81e9672d5b96620e2697eb565e3dca97b3d27 Mon Sep 17 00:00:00 2001 From: ChrisRackauckas-Claude Date: Thu, 16 Jul 2026 16:14:14 -0400 Subject: [PATCH] Use rendered docs QA in FindFirstFunctions Co-Authored-By: Chris Rackauckas --- docs/src/auto.md | 4 ++-- docs/src/index.md | 2 +- test/qa/qa.jl | 34 +--------------------------------- 3 files changed, 4 insertions(+), 36 deletions(-) diff --git a/docs/src/auto.md b/docs/src/auto.md index 86fed15..b4fcad6 100644 --- a/docs/src/auto.md +++ b/docs/src/auto.md @@ -128,12 +128,12 @@ current answer than the linear-extrapolation guess from the endpoints. ## Reproducing the benchmarks -The full sweep lives at [`bench/auto_sweep.jl`](https://github.com/SciML/FindFirstFunctions.jl/blob/main/bench/auto_sweep.jl) +The full sweep lives at [`bench/auto_sweep.jl`](https://raw.githubusercontent.com/SciML/FindFirstFunctions.jl/main/bench/auto_sweep.jl) with the regime grid pre-configured. Run with `julia --project=bench bench/auto_sweep.jl`. It evaluates every shipped strategy against every regime cell, computes the per-cell winner, and reports `Auto`'s slack distribution against that optimum. An analysis -helper at [`bench/analyze.jl`](https://github.com/SciML/FindFirstFunctions.jl/blob/main/bench/analyze.jl) +helper at [`bench/analyze.jl`](https://raw.githubusercontent.com/SciML/FindFirstFunctions.jl/main/bench/analyze.jl) reads the resulting `bench/results.csv` and prints per-strategy win-by-regime tables. diff --git a/docs/src/index.md b/docs/src/index.md index e39aa7d..d366ac6 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -61,7 +61,7 @@ searchsortedlast!(idx, v, queries) ## 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) + [SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://sciml.github.io/ColPrac/stable/) 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. diff --git a/test/qa/qa.jl b/test/qa/qa.jl index 4fd4159..d86bfe2 100644 --- a/test/qa/qa.jl +++ b/test/qa/qa.jl @@ -2,6 +2,7 @@ using SciMLTesting, FindFirstFunctions, JET, Test run_qa( FindFirstFunctions; + api_docs_kwargs = (; rendered = true), explicit_imports = true, ei_kwargs = (; # All six are Base internals accessed by qualification (GC.@preserve, @@ -20,36 +21,3 @@ run_qa( ), ), ) - -@testset "Public API documentation coverage" begin - public_names = setdiff( - Set(names(FindFirstFunctions; all = false, imported = false)), - Set((nameof(FindFirstFunctions),)), - ) - - documented_names = Set{Symbol}() - for binding in keys(Base.Docs.meta(FindFirstFunctions)) - binding.mod === FindFirstFunctions && push!(documented_names, binding.var) - end - - docs_names = Set{Symbol}() - docs_dir = joinpath(pkgdir(FindFirstFunctions), "docs", "src") - for file in readdir(docs_dir; join = true) - endswith(file, ".md") || continue - in_docs_block = false - for line in eachline(file) - stripped = strip(line) - if startswith(stripped, "```@docs") - in_docs_block = true - elseif in_docs_block && startswith(stripped, "```") - in_docs_block = false - elseif in_docs_block - m = match(r"^FindFirstFunctions\.([A-Za-z_][A-Za-z_0-9!]*$)", stripped) - m === nothing || push!(docs_names, Symbol(m.captures[1])) - end - end - end - - @test isempty(setdiff(public_names, documented_names)) - @test isempty(setdiff(public_names, docs_names)) -end