Update src/AbstractMCMC.jl

Co-authored-by: David Widmann <devmotion@users.noreply.github.com>
TuringLang · Oct 23, 2021 · 7fa8de0 · 7fa8de0
1 parent e2bdfb7
commit 7fa8de0
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/src/AbstractMCMC.jl b/src/AbstractMCMC.jl
@@ -97,7 +97,10 @@ end
 """
     setparameters!!(state, parameters)
 
-Return new instance of `state` with parameters set to `parameters`.
+Update the parameters of the `state` with `parameters` and return it.
+
+If `state` can be updated in-place, it is expected that this function returns `state` with updated
+parameters. Otherwise a new `state` object with the new `parameters` is returned.
 """
 setparameters!!