DOC: stats: Correct levy_stable loc-scale note #19175
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
Replace generic after_notes in levy_stable doc string to note exception for `S1` parameterization when alpha==1. [skip actions] [skip cirrus]
Extra space at start of one line made it render separately instead of flowing with surrounding text. Removed that space. [skip actions] [skip cirrus]
mdhaber
reviewed
Sep 2, 2023
mdhaber
approved these changes
Sep 2, 2023
There was a problem hiding this comment.
Thanks @lutefiskhotdish! This information is consistent with the reference, and the presentation of the information fits with the usual style of the note.
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.
Generic after_notes in stats.levy_stable doc string incorrectly asserted that the scale and location parameters
always behave in the usual way. The
S1parameterization has different scaling behavior when alpha==1.[skip actions] [skip cirrus]
Reference issue
Closes gh-19140
What does this implement/fix?
Replace generic after_notes in levy_stable doc string to note exception for
S1parameterization when alpha==1.Additional information
For info on levy-stable parameterization scale and location, see Stable Distributions, p. 9.