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

Minor: Add more doc strings to WindowExpr #6663

Merged
merged 4 commits into from
Jun 15, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jun 13, 2023

Which issue does this PR close?

More work towards #5781 by incrementally adding docstrings to the relevant WindowFunction expressions

Rationale for this change

This code needs to be well documented if we expose it and even if we don't, documenting it better will make the code easier to understand

What changes are included in this PR?

More Docstrings that describe the differences of functions on PartitionEvaluator more

Are these changes tested?

N/A

Are there any user-facing changes?

@alamb alamb added the documentation Improvements or additions to documentation label Jun 13, 2023
@github-actions github-actions bot added physical-expr Physical Expressions and removed documentation Improvements or additions to documentation labels Jun 13, 2023
Copy link
Contributor

@r4ntix r4ntix left a comment

Choose a reason for hiding this comment

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

looks like a nice improvement 👍

/// window defined in the `OVER` clause)
///
/// ```sql
/// lag(x, 1) OVER (ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING)
Copy link
Contributor

Choose a reason for hiding this comment

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

interesting that lag doesn't require explicit ordering, but it works

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm I think the example would be better with an ORDER BY -- I will update it

@alamb alamb merged commit 6caa804 into apache:main Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
physical-expr Physical Expressions
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants