Fix some docstrings #1404
Fix some docstrings #1404
Conversation
| @@ -1,5 +1,5 @@ | |||
| """ | |||
| Beta(α,β) | |||
| Beta(α, β) | |||
There was a problem hiding this comment.
NB- both forms are present in various docstrings at the moment; I did not go through to make ALL of them consistent yet, only the ones I was editing anyways.
| Chernoff() | ||
| pdf(Chernoff(),x::Real) | ||
| cdf(Chernoff(),x::Real) | ||
| logpdf(Chernoff(),x::Real) | ||
| survivor(Chernoff(),x::Real) | ||
| mean(Chernoff()) | ||
| var(Chernoff()) | ||
| skewness(Chernoff()) | ||
| kurtosis(Chernoff()) | ||
| kurtosis(Chernoff(), excess::Bool) | ||
| mode(Chernoff()) | ||
| entropy(Chernoff()) | ||
| rand(Chernoff()) | ||
| rand(rng, Chernoff() | ||
| cdf(Chernoff(),-x) #For tail probabilities, use this instead of 1-cdf(Chernoff(),x) |
There was a problem hiding this comment.
this was the only distribution that has all the methods in the docstring; it only seems to make sense to keep the ones that are only defined for a distribution or have very specific behavior, so the only one I kept was the last one, but I'm happy to hear your thoughts on what this should be:)
Codecov Report
@@ Coverage Diff @@
## master #1404 +/- ##
==========================================
+ Coverage 82.99% 83.05% +0.05%
==========================================
Files 117 117
Lines 6751 6756 +5
==========================================
+ Hits 5603 5611 +8
+ Misses 1148 1145 -3
Continue to review full report at Codecov.
|
Follow-up from reviewing #1403