invenia / Impute.jl

Imputation methods for missing data in julia
https://invenia.github.io/Impute.jl/latest/
Other
77 stars 11 forks source link

Update impute/impute! docstrings #145

Open ElOceanografo opened 2 months ago

ElOceanografo commented 2 months ago

Documentation changes to resolve my confusion in https://github.com/invenia/Impute.jl/issues/144. I combined the docstrings for impute and impute!, since their interfaces are basically identical, the only difference being whether or not they mutate their argument. I also and added some more examples/doctests to show explicitly how the dims keyword arg works. Happy to make more changes if there are subtleties or special cases of the interface I'm missing!