Skip to content

Commit bcfdd93

Browse files
committed
Improve docstrings
1 parent c40a193 commit bcfdd93

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/contexts/init.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
44
Abstract type representing the possible ways of initialising new values for
55
the random variables in a model (e.g., when creating a new VarInfo).
6+
7+
Any subtype of `AbstractInitStrategy` must implement the
8+
[`DynamicPPL.init`](@ref) method.
69
"""
710
abstract type AbstractInitStrategy end
811

@@ -11,8 +14,8 @@ abstract type AbstractInitStrategy end
1114
1215
Generate a new value for a random variable with the given distribution.
1316
14-
!!! warning "Values must be unlinked"
15-
The values returned by `init` are always in the untransformed space, i.e.,
17+
!!! warning "Return values must be unlinked"
18+
The values returned by `init` must always be in the untransformed space, i.e.,
1619
they must be within the support of the original distribution. That means that,
1720
for example, `init(rng, dist, u::UniformInit)` will in general return values that
1821
are outside the range [u.lower, u.upper].

0 commit comments

Comments
 (0)