Skip to content

DOC: ddof in cov when nans present #52137

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

Merged
merged 7 commits into from
Mar 27, 2023
Merged

Conversation

ma-ma-hima
Copy link
Contributor

This PR adds a document about the "nans must not be present in the dataframe" restriction on ddof in pandas.DataFrame.cov.

@ma-ma-hima
Copy link
Contributor Author

This is my first time OSS contributing.
Code Checks / pre-commit (pull_request) is failing, what should I fix?
Please tell me!!

@topper-123
Copy link
Contributor

Hey @whooolemilk Thanks for picking this up!

In general, how to work with errors (there will be many) is to look into the test logs and find the relevant log line. In this case try to look into the Doc Build and Upload / Doc Build and Upload (pull_request) one and you'll see an error message rst inline code next to normal text,i..e, its the "nans" part that is the problem.

@mroeschke mroeschke added the Docs label Mar 23, 2023
@topper-123
Copy link
Contributor

To avoid the rst check issue you could just reword the sentence, for example This argument is applicable only when no ``nan`` is in the dataframe.

@topper-123 topper-123 added this to the 2.1 milestone Mar 27, 2023
@topper-123 topper-123 merged commit 898ab21 into pandas-dev:main Mar 27, 2023
@topper-123
Copy link
Contributor

Looks good. Thanks @whooolemilk.

@ma-ma-hima
Copy link
Contributor Author

@topper-123
Thanks for letting me know

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: ddof in cov when nans present
3 participants