Skip to content

Use rendered docs QA in FindFirstFunctions #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisRackauckas merged 1 commit into from
Jul 20, 2026
Merged

Use rendered docs QA in FindFirstFunctions #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/auto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
34 changes: 1 addition & 33 deletions test/qa/qa.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -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
Loading