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: correction / update of docstrings of distributions in scipy.stats #9170

Merged
merged 2 commits into from
Aug 25, 2018

Conversation

chrisb83
Copy link
Member

I tried to correct minor issues in the docstrings of continuous distributions.

  • specify ranges of parameters and support of distribution
  • fix minor Latex erros and tried to improve layout in general

Closes #6358
Closes #8878 (clarify difference between vonmises and vonmises_line)

@chrisb83 chrisb83 added scipy.stats Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Aug 21, 2018
where ``lambda = (K * scale)**(-1)``.
It can be thought of as the sum of a standard normal random
variable and an exponentially distributed random variable with rate
``1/K``.
Copy link
Member

Choose a reason for hiding this comment

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

In wikipedia and previous definition loc and scale are only used for the normal part.
How does this match up with the loc and scale shift that we have generically.
i.e. there should be a some explanation about the effect of scale, my guess similar to the old definition of lambda
or how do we need to choose k if we have lambda and normal-scale?

Copy link
Member Author

Choose a reason for hiding this comment

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

In standard form, with X standard normal and Y exponential with rate 1/K , X + Y is exponnorm, thus loc + scale*(X + Y) is the sum of norm(loc, scale) and scale * Y and the rate parameter of the exponential distribution scales as stated in the old documentation.

I think it is better to state the standard form only this point, the scaling is explained after the notes with a reference to wikipedia.

@ev-br ev-br merged commit ce320b7 into scipy:master Aug 25, 2018
@ev-br
Copy link
Member

ev-br commented Aug 25, 2018

LGTM, thanks @chrisb83 , @josef-pkt

@ev-br ev-br added this to the 1.2.0 milestone Aug 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.stats
Projects
None yet
3 participants