Skip to content

Improve NamedDist docstring with fields documentation #1370

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

Merged
penelopeysm merged 2 commits into from
Apr 26, 2026
+9 −1
Merged

Improve NamedDist docstring with fields documentation #1370

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00d5bb5
Improve NamedDist docstring with fields documentation
ArpanC6 Apr 26, 2026
09895d4
Address review feedback: use constructor signature and TYPEDFIELDS
ArpanC6 Apr 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/distribution_wrappers.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,19 @@ using Distributions:
using FillArrays: Fill

"""
NamedDist(dist::Distribution, name::Symbol)

A named distribution that carries the name of the random variable with it.

# Fields

$(TYPEDFIELDS)
"""
struct NamedDist{variate,support,Td<:Distribution{variate,support},Tv<:VarName} <:
Distribution{variate,support}
"the underlying distribution"
dist::Td
"the name of the random variable"
name::Tv
end

Expand Down Expand Up @@ -122,4 +130,4 @@ function arraydist(dists::AbstractArray{<:Distribution})
end
function arraydist(dists::AbstractVector{<:UnivariateDistribution})
return Product(dists)
end
end