Skip to content

Commit 43a9558

Browse files
authored
Add fields to docstring for AD test utils (#914)
* Add fields to docstring for AD test utils * Bump patch
1 parent a134ecc commit 43a9558

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name = "DynamicPPL"
22
uuid = "366bfd00-2699-11ea-058f-f148b4cae6d8"
3-
version = "0.36.1"
3+
version = "0.36.2"
44

55
[deps]
66
ADTypes = "47edcb42-4c32-4615-8424-f2b9edc5f35b"

src/test_utils/ad.jl

+6
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ const REFERENCE_ADTYPE = AutoForwardDiff()
2626
Exception thrown when an AD backend returns an incorrect value or gradient.
2727
2828
The type parameter `T` is the numeric type of the value and gradient.
29+
30+
# Fields
31+
$(TYPEDFIELDS)
2932
"""
3033
struct ADIncorrectException{T<:AbstractFloat} <: Exception
3134
value_expected::T
@@ -41,6 +44,9 @@ Data structure to store the results of the AD correctness test.
4144
4245
The type parameter `Tparams` is the numeric type of the parameters passed in;
4346
`Tresult` is the type of the value and the gradient.
47+
48+
# Fields
49+
$(TYPEDFIELDS)
4450
"""
4551
struct ADResult{Tparams<:AbstractFloat,Tresult<:AbstractFloat}
4652
"The DynamicPPL model that was tested"

0 commit comments

Comments
 (0)