Distributions.jl icon indicating copy to clipboard operation
Distributions.jl copied to clipboard

Fix `fit` docs

Open ParadaCarleton opened this issue 1 year ago • 9 comments

fit doesn't need a specific docstring just for Beta.

ParadaCarleton avatar Jul 07 '23 16:07 ParadaCarleton

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 85.96%. Comparing base (818814f) to head (08ad0fb).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1746   +/-   ##
=======================================
  Coverage   85.96%   85.96%           
=======================================
  Files         144      144           
  Lines        8647     8647           
=======================================
  Hits         7433     7433           
  Misses       1214     1214           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Jul 07 '23 16:07 codecov-commenter

Any objections to merging this?

ParadaCarleton avatar Jul 10 '23 02:07 ParadaCarleton

I mentioned this in Issue #1701. For sure docstring for Beta should be removed, but currently fit has no general docstring for a distribution fit. The question is should it be added.

jaksle avatar Jul 11 '23 16:07 jaksle

IMO we should add a docstring for generic fit, if this can be done in a clear and informative way, before removing the docstring for Beta. The possible problem with a generic docstring is that it is not clear which distributions are supported and what the (keyword) arguments are for the individual distributions.

devmotion avatar Jul 12 '23 11:07 devmotion

maybe related #1748

I assume now that Poisson is not supported as stated in doc of fit_mle.

i9e1 avatar Jul 14 '23 15:07 i9e1

Anything else to do before merging?

ParadaCarleton avatar Jul 14 '23 21:07 ParadaCarleton

Anything else or can I merge?

ParadaCarleton avatar Jul 17 '23 17:07 ParadaCarleton

Anything else?

ParadaCarleton avatar Jul 20 '23 18:07 ParadaCarleton

@devmotion should I merge?

ParadaCarleton avatar Oct 11 '23 01:10 ParadaCarleton

Merge?

ViralBShah avatar May 07 '24 16:05 ViralBShah

Why was this merged? Docs seem to be broken (missing docstrings): https://juliastats.org/Distributions.jl/dev/fit/

devmotion avatar May 17 '24 21:05 devmotion