Skip to content

Commit 8d0cf3d

Browse files
committed
Update ParamsInit comment
1 parent b4bcd7e commit 8d0cf3d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/contexts/init.jl

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,17 +91,17 @@ struct ParamsInit{P,S<:AbstractInitStrategy} <: AbstractInitStrategy
9191
end
9292
end
9393
function init(rng::Random.AbstractRNG, vn::VarName, dist::Distribution, p::ParamsInit)
94-
# TODO(penelopeysm): We should do a check to make sure that all of the
95-
# parameters in `p.params` were actually used, and either warn or error if
96-
# they aren't. This is non-trivial (we need to use something like
97-
# varname_leaves), so I'm going to defer it to a later PR.
94+
# TODO(penelopeysm): It would be nice to do a check to make sure that all
95+
# of the parameters in `p.params` were actually used, and either warn or
96+
# error if they aren't. This is actually quite non-trivial though because
97+
# the structure of Dicts in particular can have arbitrary nesting.
9898
return if hasvalue(p.params, vn, dist)
9999
x = getvalue(p.params, vn, dist)
100100
if x === missing
101101
init(rng, vn, dist, p.default)
102102
else
103-
# TODO(penelopeysm): We could also check that the type of x matches
104-
# the dist?
103+
# TODO(penelopeysm): Since x is user-supplied, maybe we could also
104+
# check here that the type / size of x matches the dist?
105105
x
106106
end
107107
else

0 commit comments

Comments
 (0)