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

docs(python): Clarify docstrings for closed argument #6198

Merged
merged 2 commits into from
Jan 13, 2023
Merged

docs(python): Clarify docstrings for closed argument #6198

merged 2 commits into from
Jan 13, 2023

Conversation

stinodego
Copy link
Member

Resolves #6180

Changes:

  • Rename the type alias from ClosedWindow to ClosedInterval. I think it's a bit more clear. I left the Rust enum alone.
  • Slightly reword the docstring for the closed argument to hopefully make it clear that closed = inclusive.

@github-actions github-actions bot added docs python Related to Python Polars labels Jan 12, 2023
@ritchie46 ritchie46 merged commit ccc4b2e into pola-rs:master Jan 13, 2023
@stinodego stinodego added the documentation Improvements or additions to documentation label Jan 19, 2023
@stinodego stinodego deleted the closed-inclusive branch February 22, 2023 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation python Related to Python Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rename closed argument to inclusive
2 participants
@stinodego @ritchie46