Skip to content

Commit

Permalink
Fix docstring for dispersion (#284)
Browse files Browse the repository at this point in the history
σ² is only returned when sqr=true.
  • Loading branch information
nalimilan authored Feb 16, 2019
1 parent 84da7f1 commit dbb0556
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/glmfit.jl
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,7 @@ Distributions.Distribution(m::GeneralizedLinearModel) = Distribution(m.rr)
dispersion(m::AbstractGLM, sqr::Bool=false)
Return the estimated dispersion (or scale) parameter for a model's distribution,
generally written σ² for linear models and ϕ for generalized linear models.
generally written σ for linear models and ϕ for generalized linear models.
It is, by definition, equal to 1 for the Bernoulli, Binomial, and Poisson families.
If `sqr` is `true`, the squared dispersion parameter is returned.
Expand Down

0 comments on commit dbb0556

Please sign in to comment.