Skip to content

Commit f7388ec

Browse files
committed
reflect changes to tester in docs
1 parent cb53974 commit f7388ec

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/testers.jl

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,14 +283,16 @@ function _is_inferrable(f, args...; kwargs...)
283283
end
284284

285285
"""
286-
_test_cotangent(accum_cotangent, ad_cotangent, fd_cotangent; kwargs...)
286+
_test_cotangent(accum_cotangent, ad_cotangent, fd_cotangent[, msg]; kwargs...)
287287
288288
Check if the cotangent `ad_cotangent` from `rrule` is consistent with `accum_tangent` and
289289
approximately equal to the cotangent `fd_cotangent` obtained with finite differencing.
290290
291291
If `accum_cotangent` is `NoTangent()`, i.e., the argument was marked as non-differentiable,
292292
`ad_cotangent` and `fd_cotangent` should be `NoTangent()` as well.
293293
294+
If a msg string is given, it is emmited on test failure.
295+
294296
# Keyword arguments
295297
- If `check_inferred=true` (the default) and `ad_cotangent` is a thunk, then it is checked if
296298
its content can be inferred.

0 commit comments

Comments
 (0)