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

Doc and README.md fixes #183

Merged
merged 1 commit into from
Jun 6, 2017
Merged

Doc and README.md fixes #183

merged 1 commit into from
Jun 6, 2017

Conversation

nalimilan
Copy link
Member

Remove list of extractors which are documented in StatsBase (the
docstrings where out of sync for coeftable).
Remove outdated references in README and add new badges.


The docs don't seem to be used anywhere so it doesn't really matter. At some point we should move all documentation from README.md to a proper Documenter manual (#138 is a good step toward that goal).

README.md Outdated
[![GLM](http://pkg.julialang.org/badges/GLM_0.5.svg)](http://pkg.julialang.org/?pkg=GLM)
[![GLM](http://pkg.julialang.org/badges/GLM_0.6.svg)](http://pkg.julialang.org/?pkg=GLM)

## Older versions

This documentation applies to the current version of GLM.jl, which requires Julia 0.5 or later.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't is a safe assumption that any documentation refers to the most recent version? Seems to me that this older versions section could be removed altogether.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, and that's always annoying to have to update the reference to Julia 0.5 (which we will probably forget to do). Updated.

Remove list of extractors which are documented in StatsBase (the
docstrings where out of sync for coeftable).
Remove outdated references in README and add new badges.
@tlnagy
Copy link

tlnagy commented Jun 5, 2017

merge?

@ararslan ararslan merged commit ba06795 into master Jun 6, 2017
@ararslan ararslan deleted the nl/doc branch June 6, 2017 00:29
@ararslan
Copy link
Member

ararslan commented Jun 6, 2017

Thanks for the reminder, @tlnagy. I guess Milan and I forgot about this.

mkborregaard pushed a commit to mkborregaard/GLM.jl that referenced this pull request Jun 8, 2017
Remove list of extractors which are documented in StatsBase (the
docstrings where out of sync for coeftable).
Remove outdated references in README and add new badges.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants