Skip to content

Commit 428b628

Browse files
committed
Fix some docstrings
1 parent ec02e50 commit 428b628

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

src/model.jl

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -856,17 +856,20 @@ end
856856

857857
"""
858858
evaluate!!(model::Model, varinfo)
859-
evaluate!!(model::Model, varinfo, context)
860859
861-
Evaluate the `model` with the given `varinfo`. If an extra context stack is
862-
provided, the model's context is inserted into that context stack. See
863-
`combine_model_and_external_contexts`.
860+
Evaluate the `model` with the given `varinfo`.
864861
865862
If multiple threads are available, the varinfo provided will be wrapped in a
866863
`ThreadSafeVarInfo` before evaluation.
867864
868865
Returns a tuple of the model's return value, plus the updated `varinfo`
869866
(unwrapped if necessary).
867+
868+
evaluate!!(model::Model, varinfo, context)
869+
870+
When an extra context stack is provided, the model's context is inserted into
871+
that context stack. See `combine_model_and_external_contexts`. This method is
872+
deprecated.
870873
"""
871874
function AbstractPPL.evaluate!!(model::Model, varinfo::AbstractVarInfo)
872875
return if use_threadsafe_eval(model.context, varinfo)
@@ -924,13 +927,16 @@ end
924927

925928
"""
926929
_evaluate!!(model::Model, varinfo)
927-
_evaluate!!(model::Model, varinfo, context)
928930
929-
Evaluate the `model` with the given `varinfo`. If an additional `context` is provided,
930-
the model's context is combined with that context.
931+
Evaluate the `model` with the given `varinfo`.
931932
932933
This function does not wrap the varinfo in a `ThreadSafeVarInfo`. It also does not
933934
reset the log probability of the `varinfo` before running.
935+
936+
_evaluate!!(model::Model, varinfo, context)
937+
938+
If an additional `context` is provided, the model's context is combined with
939+
that context before evaluation.
934940
"""
935941
function _evaluate!!(model::Model, varinfo::AbstractVarInfo)
936942
args, kwargs = make_evaluate_args_and_kwargs(model, varinfo)
@@ -975,7 +981,7 @@ function combine_model_and_external_contexts(
975981
end
976982

977983
"""
978-
make_evaluate_args_and_kwargs(model, varinfo, context)
984+
make_evaluate_args_and_kwargs(model, varinfo)
979985
980986
Return the arguments and keyword arguments to be passed to the evaluator of the model, i.e. `model.f`e.
981987
"""

0 commit comments

Comments
 (0)