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

Jump to bottom

Rename diff() argument: n -> periods. #11875

Closed
wants to merge 1 commit into from
Closed

Rename diff() argument: n -> periods. #11875

wants to merge 1 commit into from

Conversation

LaurynasMiksys
Copy link
Contributor

Fixing documentation of pl.Expr.diff/pl.Series.diff to resolve the issue described in #11874.

Additionally, changing argument n to periods to add more consistency with pl.Expr.shift method and pd.Series.diff API. More details are provided in the issue linked above.

ritchie46
ritchie46 requested changes Oct 20, 2023
View reviewed changes
Copy link
Member

@ritchie46 ritchie46 left a comment

Choose a reason for hiding this comment

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

This requires agreement first in the issue on what we are going to do.

And if we continue we need to ensure we properly deprecate this on the python side.

@stinodego stinodego linked an issue Oct 20, 2023 that may be closed by this pull request
Misleading description of .diff() methods #11874
Closed
@LaurynasMiksys LaurynasMiksys mentioned this pull request Oct 21, 2023
Merged
@LaurynasMiksys LaurynasMiksys deleted the fix_diff_docs_and_signature branch August 28, 2024 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ritchie46 ritchie46 ritchie46 requested changes

@stinodego stinodego Awaiting requested review from stinodego

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@orlp orlp Awaiting requested review from orlp

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Misleading description of .diff() methods
2 participants
@LaurynasMiksys @ritchie46