DOC: add docstring with examples to NDFrame.__invert__ (~ operator)#65291
Open
RudrenduPaul wants to merge 1 commit intopandas-dev:mainfrom
Open
DOC: add docstring with examples to NDFrame.__invert__ (~ operator)#65291RudrenduPaul wants to merge 1 commit intopandas-dev:mainfrom
RudrenduPaul wants to merge 1 commit intopandas-dev:mainfrom
Conversation
The __invert__ dunder method (the ~ operator) had no docstring, making it invisible in the API docs and undiscoverable for users who don't know to search for the tilde operator by name. Adds a numpydoc-style docstring to NDFrame.__invert__ in generic.py covering boolean and integer Series, plus a DataFrame example, and registers Series.__invert__ in the Series API reference RST. Closes pandas-dev#62516 Built by Rudrendu Paul, developed with Claude Code
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem description
The
__invert__dunder method (the~tilde operator) has no docstring inNDFrame, soSeries.__invert__andDataFrame.__invert__show only the signature in the generated API docs with no explanation or examples.Issue: #62516
A maintainer confirmed in that issue that documenting dunder methods broadly is a positive direction.
Changes
NDFrame.__invert__inpandas/core/generic.pywith:Returns,See Also, andExamplessectionsSeries.__invert__indoc/source/reference/series.rstunder Binary operator functionsChecklist