updated tests + docstrings + warnings to use returned

Author: torfjelde

src/submodel_macro.jl

@@ -6,7 +6,7 @@ Run a Turing `model` nested inside of a Turing model.
 
 !!! warning
     This is deprecated and will be removed in a future release.
-    Use `left ~ to_sampleable(model)` instead (see [`to_sampleable`](@ref)).    
+    Use `left ~ returned(model)` instead (see [`returned(model)`](@ref)).
 
 # Examples
 
@@ -25,7 +25,7 @@ julia> @model function demo2(x, y)
 When we sample from the model `demo2(missing, 0.4)` random variable `x` will be sampled:
 ```jldoctest submodel
 julia> vi = VarInfo(demo2(missing, 0.4));
-┌ Warning: `@submodel model` is deprecated, use `left ~ to_sampleable(model)` instead.
+┌ Warning: `@submodel model` is deprecated, use `left ~ returned(model)` instead.
 │   caller = ip:0x0
 └ @ Core :-1
 
@@ -71,7 +71,7 @@ keeping track of all random variables correctly.
 
 !!! warning
     This is deprecated and will be removed in a future release.
-    Use `left ~ to_sampleable(model)` instead (see [`to_sampleable`](@ref)).
+    Use `left ~ returned(model)` instead (see [`returned(model)`](@ref)).
 
 # Examples
 ## Example models
@@ -138,7 +138,7 @@ julia> # When `prefix` is unspecified, no prefix is used.
 submodel_noprefix (generic function with 2 methods)
 
 julia> @varname(x) in keys(VarInfo(submodel_noprefix()))
-┌ Warning: `@submodel model` is deprecated, use `left ~ to_sampleable(model)` instead.
+┌ Warning: `@submodel model` is deprecated, use `left ~ returned(model)` instead.
 │   caller = ip:0x0
 └ @ Core :-1
 true
@@ -224,7 +224,7 @@ function prefix_submodel_context(prefix::Bool, ctx)
     return ctx
 end
 
-const SUBMODEL_DEPWARN_MSG = "`@submodel model` and `@submodel prefix=... model` are deprecated, use `left ~ to_sampleable(returned(model))` and `left ~ to_sampleable(returned(prefix(model, ...)))`, respectively, instead."
+const SUBMODEL_DEPWARN_MSG = "`@submodel model` and `@submodel prefix=... model` are deprecated, use `left ~ returned(returned(model))` and `left ~ returned(returned(prefix(model, ...)))`, respectively, instead."
 
 function submodel(prefix_expr, expr, ctx=esc(:__context__))
     prefix_left, prefix = getargs_assignment(prefix_expr)
@@ -244,7 +244,7 @@ function submodel(prefix_expr, expr, ctx=esc(:__context__))
     return if args_assign === nothing
         ctx = prefix_submodel_context(prefix, ctx)
         quote
-            # Raise deprecation warning to let user know that we recommend using `left ~ to_sampleable(model)`.
+            # Raise deprecation warning to let user know that we recommend using `left ~ returned(model)`.
             $(Base.depwarn)(SUBMODEL_DEPWARN_MSG, Symbol("@submodel"))
 
             $retval, $(esc(:__varinfo__)) = $(_evaluate!!)(
@@ -263,7 +263,7 @@ function submodel(prefix_expr, expr, ctx=esc(:__context__))
             )
         end
         quote
-            # Raise deprecation warning to let user know that we recommend using `left ~ to_sampleable(model)`.
+            # Raise deprecation warning to let user know that we recommend using `left ~ returned(model)`.
             $(Base.depwarn)(SUBMODEL_DEPWARN_MSG, Symbol("@submodel"))
 
             $retval, $(esc(:__varinfo__)) = $(_evaluate!!)(

test/compiler.jl

@@ -388,7 +388,7 @@ module Issue537 end
         @test_logs(
             (
                 :warn,
-                "`@submodel model` and `@submodel prefix=... model` are deprecated, use `left ~ to_sampleable(model)` and `left ~ to_sampleable(prefix(model, ...))`, respectively, instead.",
+                "`@submodel model` and `@submodel prefix=... model` are deprecated, use `left ~ returned(model)` and `left ~ returned(prefix(model, ...))`, respectively, instead.",
             ),
             outer()()
         )
@@ -397,7 +397,7 @@ module Issue537 end
         @test_logs(
             (
                 :warn,
-                "`@submodel model` and `@submodel prefix=... model` are deprecated, use `left ~ to_sampleable(model)` and `left ~ to_sampleable(prefix(model, ...))`, respectively, instead.",
+                "`@submodel model` and `@submodel prefix=... model` are deprecated, use `left ~ returned(model)` and `left ~ returned(prefix(model, ...))`, respectively, instead.",
             ),
             outer_with_prefix()()
         )
@@ -490,7 +490,7 @@ module Issue537 end
             num_steps = length(y[1])
             num_obs = length(y)
             @inbounds for i in 1:num_obs
-                x ~ to_sampleable(prefix(AR1(num_steps, α, μ, σ), "ar1_$i"))
+                x ~ returned(prefix(AR1(num_steps, α, μ, σ), "ar1_$i"))
                 y[i] ~ MvNormal(x, 0.01 * I)
             end
         end

test/debug_utils.jl

@@ -45,14 +45,14 @@
         @testset "submodel" begin
             @model ModelInner() = x ~ Normal()
             @model function ModelOuterBroken()
-                z ~ to_sampleable(ModelInner())
+                z ~ returned(ModelInner())
                 return x ~ Normal()
             end
             model = ModelOuterBroken()
             @test_throws ErrorException check_model(model; error_on_failure=true)
 
             @model function ModelOuterWorking()
-                z = to_sampleable(prefix(ModelInner(), "z"))
+                z = returned(prefix(ModelInner(), "z"))
                 x ~ Normal()
                 return z
             end