Skip to content

Commit

Permalink
Fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
@brenhinkeller
brenhinkeller committed Jun 28, 2024
1 parent c8d39ef commit 3853027
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/Histograms.jl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ export histmean
```julia
histvar(counts, bincenters; corrected::Bool=true)
```
Estimate the standard deviation of the data represented by a histogram,
Estimate the variance of the data represented by a histogram,
specified as `counts` in equally spaced bins centered at `bincenters`.
If `counts` have been normalized, or represent an analytical estimate of a PDF
rather than a histogram representing counts of a dataset, Bessel's correction
to the standard deviation should likely not be performed - i.e., set the
to the variance should likely not be performed - i.e., set the
`corrected` keyword argument to `false`.
## Examples
Expand Down

2 comments on commit 3853027

@brenhinkeller
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register
Release notes:

  • Add histvar, fix histstd

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/109983

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.6.38 -m "<description of version>" 385302798aa572c9a8e222305e50e90d8937d1e6
git push origin v0.6.38

Please sign in to comment.