Fix default value corrected in mean_and_std and mean_and_var do…

…cstrings (#836)
JuliaStats · Oct 7, 2022 · 39d0433 · 39d0433
1 parent 43024d1
commit 39d0433
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/moments.jl b/src/moments.jl
@@ -90,7 +90,7 @@ std(v::RealArray, w::AbstractWeights, dim::Int;
 
 ##### Fused statistics
 """
-    mean_and_var(x, [w::AbstractWeights], [dim]; corrected=false) -> (mean, var)
+    mean_and_var(x, [w::AbstractWeights], [dim]; corrected=true) -> (mean, var)
 
 Return the mean and variance of collection `x`. If `x` is an `AbstractArray`,
 `dim` can be specified as a tuple to compute statistics over these dimensions.
@@ -105,7 +105,7 @@ function mean_and_var(x; corrected::Bool=true)
 end
 
 """
-    mean_and_std(x, [w::AbstractWeights], [dim]; corrected=false) -> (mean, std)
+    mean_and_std(x, [w::AbstractWeights], [dim]; corrected=true) -> (mean, std)
 
 Return the mean and standard deviation of collection `x`. If `x` is an `AbstractArray`,
 `dim` can be specified as a tuple to compute statistics over these dimensions.