From e470421079f2eb4f725657842fbbab40bd981fc8 Mon Sep 17 00:00:00 2001 From: abhro <5664668+abhro@users.noreply.github.com> Date: Wed, 5 Feb 2025 03:04:29 -0500 Subject: [PATCH] Fix type headers in docstrings (#1943) * Add type header and backticks to AbstractMixtureModel docstrings * Fix type header for MixtureModel docstring --- src/mixtures/mixturemodel.jl | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/mixtures/mixturemodel.jl b/src/mixtures/mixturemodel.jl index c3d3b1f91..f25fb82d9 100644 --- a/src/mixtures/mixturemodel.jl +++ b/src/mixtures/mixturemodel.jl @@ -1,19 +1,21 @@ # finite mixture models """ + AbstractMixtureModel <: Distribution - All subtypes of `AbstractMixtureModel` should implement the following methods: +All subtypes of `AbstractMixtureModel` should implement the following methods: - - ncomponents(d): the number of components + - `ncomponents(d)`: the number of components - - component(d, k): return the k-th component + - `component(d, k)`: return the k-th component - - probs(d): return a vector of prior probabilities over components. + - `probs(d)`: return a vector of prior probabilities over components. """ abstract type AbstractMixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution} <: Distribution{VF, VS} end """ -MixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution,CT<:Real} + MixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution,CT<:Real} + A mixture of distributions, parametrized on: * `VF,VS` variate and support * `C` distribution family of the mixture