Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix mean_and_var and mean_and_std docstring signature #836

Merged
merged 2 commits into from
Oct 7, 2022
Merged

Fix mean_and_var and mean_and_std docstring signature #836

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47d28ab
Fix default value of argument `corrected` in `mean_and_std` docstring
bowenszhu Oct 6, 2022
78e730a
Fix default value of argument `corrected` in `mean_and_var` docstring
bowenszhu Oct 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/moments.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down