Add docstrings to tilde_assume/_observe functions

Author: phipsgabler

src/context_implementations.jl

@@ -35,7 +35,14 @@ function tilde(ctx::MiniBatchContext, sampler, right, left::VarName, inds, vi)
     return tilde(ctx.ctx, sampler, right, left, inds, vi)
 end
 
+"""
+    tilde_assume(ctx, sampler, right, vn, inds, vi)
 
+This method is applied in the generated code for assumed variables, e.g., `x ~ Normal()` where
+`x` does not occur in the model inputs.
+
+Falls back to `tilde(ctx, sampler, right, vn, inds, vi)`.
+"""
 function tilde_assume(ctx, sampler, right, vn, inds, vi)
     return tilde(ctx, sampler, right, vn, inds, vi)
 end
@@ -74,9 +81,25 @@ function tilde(ctx::MiniBatchContext, sampler, right, left, vi)
     return ctx.loglike_scalar * tilde(ctx.ctx, sampler, right, left, vi)
 end
 
+"""
+    tilde_observe(ctx, sampler, right, left, vname, vinds, vi)
+
+This method is applied in the generated code for observed variables, e.g., `x ~ Normal()` where
+`x` does occur the model inputs.
+
+Falls back to `tilde(ctx, sampler, right, left, vi)` ignoring the information about variable
+name and indices; if needed, these can be accessed through this function, though.
+"""
 function tilde_observe(ctx, sampler, right, left, vname, vinds, vi)
     return tilde(ctx, sampler, right, left, vi)
 end
+
+"""
+    tilde_observe(ctx, sampler, right, left, vi)
+
+This method is applied in the generated code for observed constants, e.g., `1.0 ~ Normal()`.
+Falls back to `tilde(ctx, sampler, right, left, vi)`.
+"""
 function tilde_observe(ctx, sampler, right, left, vi)
     return tilde(ctx, sampler, right, left, vi)
 end
@@ -177,6 +200,14 @@ function dot_tilde(
     return _dot_tilde(sampler, dist, left, vns, vi)
 end
 
+"""
+    dot_tilde_assume(ctx, sampler, right, left, vn, inds, vi)
+
+This method is applied in the generated code for assumed vectorized variables, e.g., `x .~
+MvNormal()` where `x` does not occur in the model inputs.
+
+Falls back to `dot_tilde(ctx, sampler, right, left, vn, inds, vi)`.
+"""
 function dot_tilde_assume(ctx, sampler, right, left, vn, inds, vi)
     return dot_tilde(ctx, sampler, right, left, vn, inds, vi)
 end
@@ -356,9 +387,25 @@ function dot_tilde(ctx::MiniBatchContext, sampler, right, left, vi)
     return ctx.loglike_scalar * dot_tilde(ctx.ctx, sampler, right, left, left, vi)
 end
 
+"""
+    dot_tilde_observe(ctx, sampler, right, left, vname, vinds, vi)
+
+This method is applied in the generated code for vectorized observed variables, e.g., `x .~
+MvNormal()` where `x` does occur the model inputs.
+
+Falls back to `dot_tilde(ctx, sampler, right, left, vi)` ignoring the information about variable
+name and indices; if needed, these can be accessed through this function, though.
+"""
 function dot_tilde_observe(ctx, sampler, right, left, vn, inds, vi)
     return dot_tilde(ctx, sampler, right, left, vi)
 end
+
+"""
+    dot_tilde_observe(ctx, sampler, right, left, vi)
+
+This method is applied in the generated code for vectorized observed constants, e.g., `[1.0] .~
+MvNormal()`.  Falls back to `dot_tilde(ctx, sampler, right, left, vi)`.
+"""
 function dot_tilde_observe(ctx, sampler, right, left, vi)
     return dot_tilde(ctx, sampler, right, left, vi)
 end