Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions src/FiniteDiff.jl
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,17 @@ include("jacobians.jl")
include("hessians.jl")
include("jvp.jl")

# Mark the documented user-facing API (the names rendered in the docs' `@docs`
# blocks) as public. `public` is a keyword only on Julia 1.11+, so it is emitted
# via `eval` guarded on the version to keep this source parseable on the 1.10 LTS.
@static if VERSION >= v"1.11.0-DEV.469"
eval(Expr(:public,
:finite_difference_derivative, :finite_difference_derivative!,
:finite_difference_gradient, :finite_difference_gradient!,
:finite_difference_jacobian, :finite_difference_jacobian!,
:finite_difference_hessian, :finite_difference_hessian!,
:finite_difference_jvp, :finite_difference_jvp!,
:DerivativeCache, :GradientCache, :JacobianCache, :HessianCache, :JVPCache))
end

end # module
27 changes: 27 additions & 0 deletions test/public_api_tests.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
using FiniteDiff, Test

# The documented user-facing API: every name rendered in a `@docs` block in the
# manual. These must be reachable and, on Julia 1.11+, marked `public` so that
# downstream packages' ExplicitImports/Aqua qualified-access checks pass.
const PUBLIC_API = (
:finite_difference_derivative, :finite_difference_derivative!,
:finite_difference_gradient, :finite_difference_gradient!,
:finite_difference_jacobian, :finite_difference_jacobian!,
:finite_difference_hessian, :finite_difference_hessian!,
:finite_difference_jvp, :finite_difference_jvp!,
:DerivativeCache, :GradientCache, :JacobianCache, :HessianCache, :JVPCache,
)

@testset "Public API is defined" begin
for name in PUBLIC_API
@test isdefined(FiniteDiff, name)
end
end

@static if VERSION >= v"1.11.0-DEV.469"
@testset "Public API is marked public" begin
for name in PUBLIC_API
@test Base.ispublic(FiniteDiff, name)
end
end
end
1 change: 1 addition & 0 deletions test/runtests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ end
@time begin

if GROUP == "All" || GROUP == "Core"
@time @safetestset "Public API Tests" begin include("public_api_tests.jl") end
@time @safetestset "FiniteDiff Standard Tests" begin include("finitedifftests.jl") end
@time @safetestset "Color Differentiation Tests" begin include("coloring_tests.jl") end
@time @safetestset "Out of Place Tests" begin include("out_of_place_tests.jl") end
Expand Down
Loading