Update docstrings

Author: phipsgabler

src/context_implementations.jl

@@ -36,13 +36,12 @@ function tilde(ctx::MiniBatchContext, sampler, right, left::VarName, inds, vi)
 end
 
 """
-    tilde_assume(ctx, sampler, right, vn, inds, vi) -> sampled value
+    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.
+Handles assumed variables, e.g., `x ~ Normal()` (where `x` does occur in the model inputs),
+accumulates the log probability, and returns the sampled value.
 
-Falls back to `tilde(ctx, sampler, right, vn, inds, vi)`, but automatically accumulates the
-log-probability and returns only the sampled value.
+Falls back to `tilde(ctx, sampler, right, vn, inds, vi)`.
 """
 function tilde_assume(ctx, sampler, right, vn, inds, vi)
     value, logp = tilde(ctx, sampler, right, vn, inds, vi)
@@ -73,14 +72,13 @@ function tilde(ctx::MiniBatchContext, sampler, right, left, vi)
 end
 
 """
-    tilde_observe(ctx, sampler, right, left, vname, vinds, vi) -> observed value
+    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 in the model inputs.
+Handles observed variables, e.g., `x ~ Normal()` (where `x` does occur in the model inputs),
+accumulates the log probability, and returns the observed value.
 
 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.  Automatically
-accumulates the log-probability and returns only the observed value.
+and indices; if needed, these can be accessed through this function, though.
 """
 function tilde_observe(ctx, sampler, right, left, vname, vinds, vi)
     logp = tilde(ctx, sampler, right, left, vi)
@@ -89,11 +87,12 @@ function tilde_observe(ctx, sampler, right, left, vname, vinds, vi)
 end
 
 """
-    tilde_observe(ctx, sampler, right, left, vi) -> observed value
+    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)`.  Automatically accumulates the log-probability
-and returns only the observed value.
+Handles observed constants, e.g., `1.0 ~ Normal()`, accumulates the log probability, and returns the
+observed value.
+
+Falls back to `tilde(ctx, sampler, right, left, vi)`.
 """
 function tilde_observe(ctx, sampler, right, left, vi)
     logp = tilde(ctx, sampler, right, left, vi)
@@ -198,13 +197,12 @@ function dot_tilde(
 end
 
 """
-    dot_tilde_assume(ctx, sampler, right, left, vn, inds, vi) -> sampled value
+    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.
+Handles broadcasted assumed variables, e.g., `x .~ MvNormal()` (where `x` does not occur in the
+model inputs), accumulates the log probability, and returns the sampled value.
 
-Falls back to `dot_tilde(ctx, sampler, right, left, vn, inds, vi)`, but automatically accumulates
-the log-probability and returns only the sampled value.
+Falls back to `dot_tilde(ctx, sampler, right, left, vn, inds, vi)`.
 """
 function dot_tilde_assume(ctx, sampler, right, left, vn, inds, vi)
     value, logp = dot_tilde(ctx, sampler, right, left, vn, inds, vi)
@@ -377,14 +375,13 @@ function dot_tilde(ctx::MiniBatchContext, sampler, right, left, vi)
 end
 
 """
-    dot_tilde_observe(ctx, sampler, right, left, vname, vinds, vi) -> observed value
+    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.
+Handles broadcasted observed values, e.g., `x .~ MvNormal()` (where `x` does occur the model inputs),
+accumulates the log probability, and returns the observed value.
 
 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.  Automatically
-accumulates the log-probability and returns only the observed value.
+name and indices; if needed, these can be accessed through this function, though.
 """
 function dot_tilde_observe(ctx, sampler, right, left, vn, inds, vi)
     logp = dot_tilde(ctx, sampler, right, left, vi)
@@ -393,11 +390,12 @@ function dot_tilde_observe(ctx, sampler, right, left, vn, inds, vi)
 end
 
 """
-    dot_tilde_observe(ctx, sampler, right, left, vi) -> observed value
+    dot_tilde_observe(ctx, sampler, right, left, vi)
+
+Handles broadcasted observed constants, e.g., `[1.0] .~ MvNormal()`, accumulates the log
+probability, and returns the observed value.
 
-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)`.  Automatically
-accumulates the log-probability and returns only the observed value.
+Falls back to `dot_tilde(ctx, sampler, right, left, vi)`.
 """
 function dot_tilde_observe(ctx, sampler, right, left, vi)
     logp = dot_tilde(ctx, sampler, right, left, vi)