DOC: stats: A few tweaks to the linregress docstring. #8839
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
The main reason for this change is to not print r_value**2 with full precision in the docstring. There is no guarantee that the value will be *exactly* the same as the code in scipy evolves, and as it was, even a change of 1 ULP would cause a doctest to fail. I also added a line to print the slope and intercept of the regression line in the docstring, and modified the sample data to have a nontrivial slope.
WarrenWeckesser
added
scipy.stats
Documentation
This was referenced May 18, 2018
|
Merging straight away to unblock the CI. Thanks Warren. Going forward, I'd note that the issue here was a print function with text. Without text at the same output line, the numeric values would have been compared via |
Thanks, I didn't know that. |
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 main reason for this change is to not print r_value**2 with
full precision in the docstring. There is no guarantee that the
value will be exactly the same as the code in scipy evolves,
and as it was, even a change of 1 ULP would cause a doctest to
fail.
I also added a line to print the slope and intercept of the
regression line in the docstring, and modified the sample
data to have a nontrivial slope.