DOC: clarified parameterization of stats.lognorm #5075
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
related #4538 |
ev-br
added
scipy.stats
Documentation
|
Not sure what is meant by a "unique" in "unique normally distributed random variable". Anyway, LGTM. |
|
Not sure if "unique" is the correct term here either, but it gets the message across just fine. Merging. |
larsmans
added a commit
that referenced
this pull request
Jul 24, 2015
DOC: clarified parameterization of stats.lognorm
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The parametrization of scipy.stats.lognorm appears to have been justified a desire for a uniform interface across random variates.
The existing phrasing of the documentation did not make it clear to new users how this translates into the standard parametrization (in particular, as a new SciPy user, it required looking through multiple docstrings and finally quitting and checking stackoverflow before I figured it out).
I added a note similar to the one under scipy.stats.expon to make it easy for new (and existing) users to translate the standard parametrization into the one required by SciPy without undue mental strain.
This addresses bug #2027. (TRAC#1502).