Skip to content

Commit 32fd6b9

Browse files
committed
Updated docstring for @returned_quantities
1 parent 692cfff commit 32fd6b9

File tree

1 file changed

+4
-11
lines changed

1 file changed

+4
-11
lines changed

src/submodel_macro.jl

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,8 @@ julia> @model function demo1(x)
307307
end;
308308
309309
julia> @model function demo2(x, y, z)
310-
a = @returned_quantities prefix(demo1(x), Val{:sub1}())
311-
b = @returned_quantities prefix(demo1(y), Val{:sub2}())
310+
a = @returned_quantities @prefix(demo1(x), :sub1)
311+
b = @returned_quantities @prefix(demo1(y), :sub2)
312312
return z ~ Uniform(-a, b)
313313
end;
314314
```
@@ -362,22 +362,15 @@ submodel_noprefix (generic function with 2 methods)
362362
julia> @varname(x) in keys(VarInfo(submodel_noprefix()))
363363
true
364364
365-
julia> # Explicitely don't use any prefix.
366-
@model submodel_prefix_false() = a = @returned_quantities prefix=false inner()
367-
submodel_prefix_false (generic function with 2 methods)
368-
369-
julia> @varname(x) in keys(VarInfo(submodel_prefix_false()))
370-
true
371-
372365
julia> # Using a static string.
373-
@model submodel_prefix_string() = a = @returned_quantities prefix="my prefix" inner()
366+
@model submodel_prefix_string() = a = @returned_quantities @prefix inner() "my prefix"
374367
submodel_prefix_string (generic function with 2 methods)
375368
376369
julia> @varname(var"my prefix.x") in keys(VarInfo(submodel_prefix_string()))
377370
true
378371
379372
julia> # Using string interpolation.
380-
@model submodel_prefix_interpolation() = a = @returned_quantities prefix="\$(nameof(inner()))" inner()
373+
@model submodel_prefix_interpolation() = a = @returned_quantities @prefix inner() "\$(nameof(inner()))"
381374
submodel_prefix_interpolation (generic function with 2 methods)
382375
383376
julia> @varname(var"inner.x") in keys(VarInfo(submodel_prefix_interpolation()))

0 commit comments

Comments
 (0)