Skip to content

Commit 23ee104

Browse files
committed
include docrefs explicitly in z_autodocs
1 parent 0bec154 commit 23ee104

2 files changed

Lines changed: 27 additions & 8 deletions

File tree

docs/src/z_autodocs.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,20 @@ Documentation for [DistributionFits](https://github.com/bgctw/DistributionFits.j
1414
[comment]: # (Modules = [DistributionFits])
1515

1616
[comment]: # (```)
17+
18+
19+
taken care of in index.md
20+
called only internally from fit, documented in docstring via ","
21+
```@docs
22+
fit_median_quantile
23+
fit_mean_quantile
24+
fit_mode_quantile
25+
```
26+
27+
internals
28+
```@docs
29+
meanFunOfProb
30+
ofLogitNormalModeUpper
31+
fit(Type{LogNormal}, Any, AbstractΣstar)
32+
```
33+

src/fitstats.jl

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ end
190190

191191

192192
"""
193-
fit(D, lower, upper)
193+
fit(D, lower::QuantilePoint, upper::QuantilePoint)
194194
195195
Fit a statistical distribution to a set of quantiles
196196
@@ -209,12 +209,10 @@ true
209209
"""
210210
function fit(::Type{D}, lower::QuantilePoint, upper::QuantilePoint) where D<:Distribution
211211
error("fitting to two quantile points not implemented for distribution of type $D")
212-
end,
213-
function fit_median_quantile(D::Type{DT}, median, qp::QuantilePoint) where {DT <: Distribution}
214-
return(fit(D, @qp_m(median), qp))
215212
end
216213

217214

215+
218216
"""
219217
fit(D, val, qp, ::Val{stats} = Val(:mean))
220218
@@ -247,15 +245,19 @@ function fit(::Type{D}, val, qp::QuantilePoint, ::Val{stats} = Val(:mean)) where
247245
stats == :median && return(fit_median_quantile(D, val, qp))
248246
error("unknown stats: $stats")
249247
end,
250-
# function fit_mean_quantile(d::Type{D}, mean::Real, qp::QuantilePoint) where D<:Distribution
251-
# error("fit_mean_quantile not yet implemented for Distribution of type: $D")
252-
# end
248+
function fit_median_quantile(D::Type{DT}, median, qp::QuantilePoint) where {DT <: Distribution}
249+
return(fit(D, @qp_m(median), qp))
250+
end,
253251
function fit_mean_quantile(d::Type{D}, mean::Real, qp::QuantilePoint) where D<:Distribution
254252
error("fit_mean_quantile not yet implemented for Distribution of type: $D")
255-
end
253+
end,
256254
function fit_mode_quantile(::Type{D}, mode::Real, qp::QuantilePoint) where D<:Distribution
257255
error("fit_mode_quantile not yet implemented for Distribution of type: $D")
258256
end
259257

258+
# function fit_mean_quantile(d::Type{D}, mean::Real, qp::QuantilePoint) where D<:Distribution
259+
# error("fit_mean_quantile not yet implemented for Distribution of type: $D")
260+
# end
261+
260262

261263

0 commit comments

Comments
 (0)