search

felix-clark / ndarray-glm

Rust library for linear, logistic, and generalized linear model regression
MIT License
22 stars 0 forks source link

Fit module is not documented? #18

Closed multimeric closed 3 years ago

multimeric commented 3 years ago

It seems that the Fit struct returned by the fit() method is not documented, for example. Indeed it seems that the fit module that it belongs to is also not included in the list of modules in the documentation. Is there any way you can export either the struct in the prelude or the module itself so that it's documented. There's a chance that it's not possible to use the struct in type definitions either for the same reason, certainly my autocomplete doesn't find it.

felix-clark commented 3 years ago

Indeed, given that the user is obviously meant to interact with the Fit result directly I can't think of any reason why this should have been private in the first place -- probably just an oversight. The documentation also certainly should be public (the quality of that documentation is... another issue).

I've exported the Fit object directly in f66909d, as opposed to making the module public, since I don't think users should have to manage the namespace here. Feel free to try out the 0.0.10 branch (unpublished right now - you'll have to use the git syntax in Cargo.toml) and check that the behavior of everything works as you'd expect.

multimeric commented 3 years ago

The main thing I'm after is actually the documentation page which I guess won't come until it's actually published. But it's good to know that this is coming!

felix-clark commented 3 years ago

Closing as this should be fixed in 0.0.10.