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

Add basic documentation to negbin #301

Merged
merged 1 commit into from Jan 21, 2020

Conversation

galenlynch
Copy link
Contributor

No description provided.

@codecov-io
Copy link

codecov-io commented Apr 2, 2019

Codecov Report

❗ No coverage uploaded for pull request base (master@78ecfd1). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #301   +/-   ##
=========================================
  Coverage          ?   81.17%           
=========================================
  Files             ?        7           
  Lines             ?      632           
  Branches          ?        0           
=========================================
  Hits              ?      513           
  Misses            ?      119           
  Partials          ?        0
Impacted Files Coverage Δ
src/GLM.jl 100% <ø> (ø)
src/negbinfit.jl 92.72% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 78ecfd1...8454c21. Read the comment docs.

src/negbinfit.jl Outdated
and keyword arguments will be passed to [`glm`](@ref).

# Keyword Arguments
- `initialθ::Real=Inf`: Starting values for shape parameter θ. If it is `Inf`
Copy link
Member

Choose a reason for hiding this comment

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

Singular "value".

Also, better document other arguments here rather than above, that's more logical.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@nalimilan
Copy link
Member

Thanks. Note that with #288, the argument names will switch to lower case.

Copy link
Member

@nalimilan nalimilan left a comment

Choose a reason for hiding this comment

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

Thanks. I've rebased against #288.

@galenlynch
Copy link
Contributor Author

Thanks for doing that!

@nalimilan
Copy link
Member

Sorry, this was completely forgotten. Would you mind rebasing against master?

@galenlynch
Copy link
Contributor Author

I think it's done, but it's been long enough that I've forgotten everything I knew about this function, and have only glanced at the new keyword arguments.

@nalimilan nalimilan merged commit 27d8ca9 into JuliaStats:master Jan 21, 2020
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.

None yet

3 participants