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

Merged
merged 1 commit into from
Jul 3, 2021

Conversation

attack68
Copy link
Contributor

@attack68 attack68 commented Jul 2, 2021

follows up an oversigh from #40628.
False was deprecated as an input so the example should be updated.

@attack68 attack68 changed the title fix docs after deprecation of args DOC: fix docs after deprecation of args Jul 2, 2021
@@ -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.

@jreback jreback added this to the 1.3.1 milestone Jul 3, 2021
@jreback jreback added the Deprecate Functionality to remove in pandas label Jul 3, 2021
@jreback jreback merged commit 4663377 into pandas-dev:master Jul 3, 2021
@jreback
Copy link
Contributor

jreback commented Jul 3, 2021

thanks @attack68

@jreback
Copy link
Contributor

jreback commented Jul 3, 2021

@meeseeksdev backport 1.3.x

@lumberbot-app
Copy link

lumberbot-app bot commented Jul 3, 2021

Something went wrong ... Please have a look at my logs.

simonjayhawkins pushed a commit that referenced this pull request Jul 4, 2021
Co-authored-by: attack68 <24256554+attack68@users.noreply.github.com>
@attack68 attack68 deleted the cleanup_series_between_doc branch July 4, 2021 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deprecate Functionality to remove in pandas Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants