Skip to content

docs: Document weights argument for kde function#141

Merged
tpapp merged 2 commits intoJuliaStats:masterfrom
henry2004y:docs-weights-argument
Nov 18, 2025
Merged

docs: Document weights argument for kde function#141
tpapp merged 2 commits intoJuliaStats:masterfrom
henry2004y:docs-weights-argument

Conversation

@henry2004y
Copy link
Contributor

Documents the weights argument for the kde function in the README and the documentation site. Handles #101

Documents the `weights` argument for the `kde` function in the README and the documentation site.
@henry2004y
Copy link
Contributor Author

Kindly pin the maintainers for this simple PR.

@tpapp
Copy link
Collaborator

tpapp commented Nov 17, 2025

Note that two other types are allowed (UniformWeights is a type in this package, and also it allows a vector of real numbers). See

const Weights = Union{UniformWeights, AbstractVector{<:Real}, StatsBase.Weights}

Corrects the documentation for the `weights` argument for the `kde`
function in the README and the documentation site.

The `weights` argument can be one of `UniformWeights` (from this
package), an `AbstractVector` of real numbers, or a `StatsBase.Weights`
vector.
@henry2004y
Copy link
Contributor Author

Those two types are added in the doc now.

Copy link
Collaborator

@tpapp tpapp left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@tpapp
Copy link
Collaborator

tpapp commented Nov 18, 2025

I will merge this now, should we tag a release?

@tpapp tpapp merged commit 21da517 into JuliaStats:master Nov 18, 2025
5 checks passed
@henry2004y henry2004y deleted the docs-weights-argument branch November 18, 2025 13:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants