Skip to content
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

DOC: Add notes section to .isin() docs #59201

Merged
merged 2 commits into from
Jul 8, 2024

Conversation

AnaDenisa
Copy link
Contributor

Add a Notes section to the .isin() method docs to clarify that we use iter over contains when checking each element in the values collection passed as argument. This clarification was requested because values can be a dict, which suggests that under the hood isin() uses contains rather than iter, which is not the case and might confuse some users.

Output of the docs checker script, same as before adding the doc change:

1 Errors found for `pandas.DataFrame.isin`:
	ES01	No extended summary found

image

pandas/core/frame.py Outdated Show resolved Hide resolved
@mroeschke mroeschke added the Docs label Jul 8, 2024
@mroeschke mroeschke added this to the 3.0 milestone Jul 8, 2024
@mroeschke mroeschke merged commit 58da4b0 into pandas-dev:main Jul 8, 2024
45 checks passed
@mroeschke
Copy link
Member

Thanks @AnaDenisa

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