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.

Sign up for GitHub

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: fix docs after deprecation of args #42342

Merged
merged 1 commit into from
Jul 3, 2021
Merged

DOC: fix docs after deprecation of args #42342

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pandas/core/series.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5072,9 +5072,9 @@ def between(self, left, right, inclusive="both") -> Series:
4 False
dtype: bool

With `inclusive` set to ``False`` boundary values are excluded:
With `inclusive` set to ``"neither"`` boundary values are excluded:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, remind me. why did we deprecate True/False as allowable arguments?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

because T/F is only 2 options. 'both', 'neither' 'left' 'right' is all cases. If working towards standardising this type of arg across methods, makes sense to have all encompassing options (#40245)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @attack68. There was no discussion on the deprecation of the existing parameters in #40245. The issue is labelled an enhancement. We probably should have had a discussion on the deprecation also.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the PR (#40628) was initially an expansion which allowed T/F for backwards compat. First mention of deprecation came from jreback here as part of review process and the changes were requested. I agree with your comment.


>>> s.between(1, 4, inclusive=False)
>>> s.between(1, 4, inclusive="neither")
0 True
1 False
2 False
Expand Down