Added prefix and @prefix to docs

TuringLang · Oct 29, 2024 · cc3af46 · cc3af46
1 parent 9e0730f
commit cc3af46
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/src/api.md b/docs/src/api.md
@@ -21,6 +21,13 @@ One can nest models and call another model inside the model function with [`@sub
 @returned_quantities
 ```
 
+In the context of nesting models, it's also useful to prefix the variables in sub-models to avoid variable names clashing:
+
+```@docs
+prefix(::DynamicPPL.Model, x)
+@prefix
+```
+
 ### Type
 
 A [`Model`](@ref) can be created by calling the model function, as defined by [`@model`](@ref).