Add always_use_return = true to format config

Author: mhauru

.JuliaFormatter.toml

@@ -1,2 +1,6 @@
 style="blue"
 format_markdown = true
+# The below should actually be part of Blue according to
+# https://github.com/JuliaDiff/BlueStyle?tab=readme-ov-file#method-definitions
+# but JuliaFormatter v2.10 doesn't enforce it.
+always_use_return = true

ext/DynamicPPLMCMCChainsExt.jl

@@ -254,7 +254,7 @@ function DynamicPPL.returned(model::DynamicPPL.Model, chain_full::MCMCChains.Cha
         DynamicPPL.setval_and_resample!(varinfo, chain, sample_idx, chain_idx)
         # NOTE: Some of the varialbes can be a view into the `varinfo`, so we need to
         # `deepcopy` the `varinfo` before passing it to the `model`.
-        model(deepcopy(varinfo))
+        return model(deepcopy(varinfo))
     end
 end
 

src/compiler.jl

@@ -635,7 +635,7 @@ end
 
 function namedtuple_from_splitargs(splitargs)
     names = map(splitargs) do (arg_name, arg_type, is_splat, default)
-        is_splat ? Symbol("#splat#$(arg_name)") : arg_name
+        return is_splat ? Symbol("#splat#$(arg_name)") : arg_name
     end
     names_expr = Expr(:tuple, map(QuoteNode, names)...)
     vals = Expr(:tuple, map(first, splitargs)...)

src/debug_utils.jl

@@ -521,7 +521,7 @@ function has_static_constraints(
     rng::Random.AbstractRNG, model::Model; num_evals=5, kwargs...
 )
     results = map(1:num_evals) do _
-        check_model_and_trace(rng, model; kwargs...)
+        return check_model_and_trace(rng, model; kwargs...)
     end
     issuccess = all(first, results)
     issuccess || throw(ArgumentError("model check failed"))
@@ -530,7 +530,7 @@ function has_static_constraints(
     traces = map(last, results)
     dists_per_trace = map(distributions_in_trace, traces)
     transforms = map(dists_per_trace) do dists
-        map(DynamicPPL.link_transform, dists)
+        return map(DynamicPPL.link_transform, dists)
     end
 
     # Check if the distributions are the same across all runs.

src/extract_priors.jl

@@ -106,7 +106,7 @@ julia> length(extract_priors(rng, model)[@varname(x)])
 ```
 """
 function extract_priors(args::Union{Model,AbstractVarInfo}...)
-    extract_priors(Random.default_rng(), args...)
+    return extract_priors(Random.default_rng(), args...)
 end
 function extract_priors(rng::Random.AbstractRNG, model::Model)
     context = PriorExtractorContext(SamplingContext(rng))

src/logdensityfunction.jl

@@ -248,7 +248,7 @@ By default, this just returns the input unchanged.
 function tweak_adtype(
     adtype::ADTypes.AbstractADType, ::Model, ::AbstractVarInfo, ::AbstractContext
 )
-    adtype
+    return adtype
 end
 
 """

src/model.jl

@@ -97,7 +97,7 @@ Return a `Model` which now treats variables on the right-hand side as observatio
 See [`condition`](@ref) for more information and examples.
 """
 function Base.:|(model::Model, values::Union{Pair,Tuple,NamedTuple,AbstractDict{<:VarName}})
-    condition(model, values)
+    return condition(model, values)
 end
 
 """
@@ -1069,7 +1069,7 @@ function logjoint(model::Model, chain::AbstractMCMC.AbstractChains)
                 values_from_chain(var_info, vn_parent, chain, chain_idx, iteration_idx) for
             vn_parent in keys(var_info)
         )
-        logjoint(model, argvals_dict)
+        return logjoint(model, argvals_dict)
     end
 end
 
@@ -1116,7 +1116,7 @@ function logprior(model::Model, chain::AbstractMCMC.AbstractChains)
                 values_from_chain(var_info, vn_parent, chain, chain_idx, iteration_idx) for
             vn_parent in keys(var_info)
         )
-        logprior(model, argvals_dict)
+        return logprior(model, argvals_dict)
     end
 end
 
@@ -1163,7 +1163,7 @@ function Distributions.loglikelihood(model::Model, chain::AbstractMCMC.AbstractC
                 values_from_chain(var_info, vn_parent, chain, chain_idx, iteration_idx) for
             vn_parent in keys(var_info)
         )
-        loglikelihood(model, argvals_dict)
+        return loglikelihood(model, argvals_dict)
     end
 end
 
@@ -1469,5 +1469,5 @@ ERROR: ArgumentError: `~` with a model on the right-hand side of an observe stat
 ```
 """
 function to_submodel(model::Model, auto_prefix::Bool=true)
-    to_sampleable(returned(model), auto_prefix)
+    return to_sampleable(returned(model), auto_prefix)
 end

src/model_utils.jl

@@ -204,6 +204,8 @@ function value_iterator_from_chain(vi::AbstractVarInfo, chain)
     return Iterators.map(
         Iterators.product(1:size(chain, 1), 1:size(chain, 3))
     ) do (iteration_idx, chain_idx)
-        values_from_chain!(vi, chain, chain_idx, iteration_idx, OrderedDict{VarName,Any}())
+        return values_from_chain!(
+            vi, chain, chain_idx, iteration_idx, OrderedDict{VarName,Any}()
+        )
     end
 end

src/simple_varinfo.jl

@@ -315,7 +315,7 @@ function Base.getindex(vi::SimpleVarInfo, vn::VarName, dist::Distribution)
 end
 function Base.getindex(vi::SimpleVarInfo, vns::Vector{<:VarName}, dist::Distribution)
     vals_linked = mapreduce(vcat, vns) do vn
-        getindex(vi, vn, dist)
+        return getindex(vi, vn, dist)
     end
     return recombine(dist, vals_linked, length(vns))
 end
@@ -362,7 +362,7 @@ function BangBang.setindex!!(vi::SimpleVarInfo{<:AbstractDict}, val, vn::VarName
     # Attempt to split into `parent` and `child` optic.
     parent, child, issuccess = splitoptic(getoptic(vn)) do optic
         o = optic === nothing ? identity : optic
-        haskey(dict, VarName(vn, o))
+        return haskey(dict, VarName(vn, o))
     end
     # When combined with `VarInfo`, `nothing` is equivalent to `identity`.
     keyoptic = parent === nothing ? identity : parent

src/test_utils/varinfo.jl

@@ -58,7 +58,7 @@ function setup_varinfos(
         svi_vnv_ref,
     )) do vi
         # Set them all to the same values.
-        DynamicPPL.setlogp!!(update_values!!(vi, example_values, varnames), lp)
+        return DynamicPPL.setlogp!!(update_values!!(vi, example_values, varnames), lp)
     end
 
     if include_threadsafe