Skip to content

DOC: fix mask/where docstring alignment note (#61781) #62029

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

abhaypsingh
Copy link

The explanatory paragraph wrongly said that alignment is between other and cond. It is between self and cond; values fall back to self for mis-aligned positions. Update both generic docstring templates so all Series/DataFrame variants inherit the correct wording.

Closes #61781

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

The explanatory paragraph wrongly said that alignment is between
`other` and `cond`.  It is between *self* and `cond`; values fall
back to *self* for mis-aligned positions.  Update both generic
docstring templates so all Series/DataFrame variants inherit the
correct wording.

Closes pandas-dev#61781

Signed-off-by: Abhay Singh <[email protected]>
@abhaypsingh
Copy link
Author

How do I merge this?

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

Successfully merging this pull request may close these issues.

DOC: Typo within Series.mask() docs - alignment is done between self and cond, not cond and other
1 participant