Skip to content

Commit e470421

Browse files
authored
Fix type headers in docstrings (#1943)
* Add type header and backticks to AbstractMixtureModel docstrings * Fix type header for MixtureModel docstring
1 parent 1e6801d commit e470421

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

src/mixtures/mixturemodel.jl

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
11
# finite mixture models
22

33
"""
4+
AbstractMixtureModel <: Distribution
45
5-
All subtypes of `AbstractMixtureModel` should implement the following methods:
6+
All subtypes of `AbstractMixtureModel` should implement the following methods:
67
7-
- ncomponents(d): the number of components
8+
- `ncomponents(d)`: the number of components
89
9-
- component(d, k): return the k-th component
10+
- `component(d, k)`: return the k-th component
1011
11-
- probs(d): return a vector of prior probabilities over components.
12+
- `probs(d)`: return a vector of prior probabilities over components.
1213
"""
1314
abstract type AbstractMixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution} <: Distribution{VF, VS} end
1415

1516
"""
16-
MixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution,CT<:Real}
17+
MixtureModel{VF<:VariateForm,VS<:ValueSupport,C<:Distribution,CT<:Real}
18+
1719
A mixture of distributions, parametrized on:
1820
* `VF,VS` variate and support
1921
* `C` distribution family of the mixture

0 commit comments

Comments
 (0)