Fix documentation for DataFrame.corr and Series.corr. #10493
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
bdice
added
doc
bdice
commented
Mar 23, 2022
| @@ -5664,12 +5664,20 @@ def cov(self, **kwargs): | |||
| df._set_column_names_like(self) | |||
| return df | |||
|
|
|||
| def corr(self, method="pearson"): | |||
| def corr(self, method="pearson", min_periods=None): | |||
There was a problem hiding this comment.
I added the min_periods to align with pandas. Series.corr has this parameter even though it is not supported, so I thought we should do the same for DataFrame.corr. If this is not desirable, I can revert this change and make this PR docs-only.
Codecov Report
@@ Coverage Diff @@
## branch-22.04 #10493 +/- ##
================================================
+ Coverage 86.16% 86.17% +0.01%
================================================
Files 141 141
Lines 22501 22510 +9
================================================
+ Hits 19387 19398 +11
+ Misses 3114 3112 -2
Continue to review full report at Codecov.
|
brandon-b-miller
approved these changes
Mar 23, 2022
|
@gpucibot merge |
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.
Follow-up work to fix documentation from #7141 before the 22.04 release.