Add docstring for guess_activity (#1955)

EnzymeAD · Oct 11, 2024 · 1bbcaa9 · 1bbcaa9
1 parent ad86689
commit 1bbcaa9
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/compiler.jl b/src/compiler.jl
@@ -856,6 +856,11 @@ end
     return rt == Enzyme.Compiler.AnyState || rt == Enzyme.Compiler.DupState
 end
 
+"""
+    Enzyme.guess_activity(::Type{T}, mode::Enzyme.Mode)
+
+Try to guess the most appropriate [`Annotation`](@ref) for arguments of type `T` passed to [`autodiff`](@ref) with a given `mode`.
+"""
 @inline Enzyme.guess_activity(::Type{T}, mode::Enzyme.Mode) where {T} =
     guess_activity(T, convert(API.CDerivativeMode, mode))