test: check docstrings (#640)

* test: check that all public names have docstrings * Add FiniteDiff to test deps * Remove doctests * Revert project
JuliaDiff · Nov 24, 2024 · cc8818a · cc8818a · gdalle · Nov 24, 2024
1 parent 5576221
commit cc8818a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/...face/ext/DifferentiationInterfaceForwardDiffExt/DifferentiationInterfaceForwardDiffExt.jl b/...face/ext/DifferentiationInterfaceForwardDiffExt/DifferentiationInterfaceForwardDiffExt.jl
@@ -1,22 +1,19 @@
 module DifferentiationInterfaceForwardDiffExt
 
-using ADTypes: AbstractADType, AutoForwardDiff
-using Base: Fix1, Fix2
+using ADTypes: AutoForwardDiff
 import DifferentiationInterface as DI
 using DifferentiationInterface:
     BatchSizeSettings,
     Cache,
     Constant,
     PrepContext,
     Context,
-    FixTail,
     DerivativePrep,
     DifferentiateWith,
     GradientPrep,
     HessianPrep,
     HVPPrep,
     JacobianPrep,
-    NoDerivativePrep,
     NoSecondDerivativePrep,
     PushforwardPrep,
     Rewrap,
@@ -42,17 +39,14 @@ using ForwardDiff:
     derivative,
     derivative!,
     extract_derivative,
-    extract_derivative!,
     gradient,
     gradient!,
     hessian,
     hessian!,
     jacobian,
     jacobian!,
-    npartials,
     partials,
     value
-using LinearAlgebra: dot, mul!
 
 DI.check_available(::AutoForwardDiff) = true
 

diff --git a/DifferentiationInterface/test/Misc/Internals/_formalities.jl b/DifferentiationInterface/test/Misc/Internals/_formalities.jl
@@ -23,6 +23,12 @@ end
     @test JuliaFormatter.format(DifferentiationInterface; verbose=false, overwrite=false)
 end
 
+@testset "Documentation" begin
+    if VERSION >= v"1.11"
+        @test isempty(Docs.undocumented_names(DifferentiationInterface))
+    end
+end
+
 @testset "ExplicitImports" begin
     @test check_no_implicit_imports(DifferentiationInterface) === nothing
     @test check_no_stale_explicit_imports(DifferentiationInterface) === nothing

diff --git a/DifferentiationInterfaceTest/test/formalities.jl b/DifferentiationInterfaceTest/test/formalities.jl
@@ -21,6 +21,12 @@ end
     JET.test_package(DifferentiationInterfaceTest; target_defined_modules=true)
 end
 
+@testset "Documentation" begin
+    if VERSION >= v"1.11"
+        @test isempty(Docs.undocumented_names(DifferentiationInterfaceTest))
+    end
+end
+
 @testset "ExplicitImports" begin
     @test_broken check_no_implicit_imports(DifferentiationInterfaceTest) === nothing
     @test_broken check_no_stale_explicit_imports(DifferentiationInterfaceTest) === nothing