Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding/improving inline documentation #137

Open
abhijithch opened this issue Apr 27, 2016 · 0 comments
Open

Adding/improving inline documentation #137

abhijithch opened this issue Apr 27, 2016 · 0 comments

Comments

@abhijithch
Copy link

It would be great for users to have well written, detailed just enough such that users not too familiar with statistics and the R's glm will be able to use this package with ease. It would be nice have few lines about the function, one liners about the arguments, and examples where applicable. One these lines, I have a sample helper function, for glm(),
screen shot 2016-04-27 at 5 50 33 pm

I have for now picked from the README, but will be more descriptive. @nalimilan, thanks for your comments on the previous attempt. I plan to redo the documentation and send a new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants