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

Update erlang.jl docstring #1915

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

theplatters
Copy link

Fixed the mismatch in the parameter names and gave the concrete pdf, so the reference to wikipedia doesn't create confusion.

@codecov-commenter
Copy link

codecov-commenter commented Nov 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.62%. Comparing base (aad64af) to head (900584b).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1915      +/-   ##
==========================================
- Coverage   85.99%   85.62%   -0.38%     
==========================================
  Files         144      141       -3     
  Lines        8685     8638      -47     
==========================================
- Hits         7469     7396      -73     
- Misses       1216     1242      +26     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mschauer
Copy link
Member

Thank you, it is desirable to use the same parameter names as wikipedia, so here k and beta?

@theplatters
Copy link
Author

Yeha ok either alpha and theta to be consitent with the gamma distribution, or k and beta to be consitent with wikipedia.

@@ -1,12 +1,17 @@
"""
Erlang(α)
Erlang(α=1,θ=1)

The *Erlang distribution* is a special case of a [`Gamma`](@ref) distribution with integer shape parameter.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
The *Erlang distribution* is a special case of a [`Gamma`](@ref) distribution with integer shape parameter.
The *Erlang distribution* is a special case of a [`Gamma`](@ref) distribution with integer shape parameter α and scale parameter θ.

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