-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Conversation
There was a problem hiding this 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 👍
datafusion/physical-expr/src/window/built_in_window_function_expr.rs
Outdated
Show resolved
Hide resolved
/// window defined in the `OVER` clause) | ||
/// | ||
/// ```sql | ||
/// lag(x, 1) OVER (ROWS BETWEEN 2 PRECEDING AND 3 FOLLOWING) |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
Which issue does this PR close?
More work towards #5781 by incrementally adding docstrings to the relevant
WindowFunction
expressionsRationale 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
moreAre these changes tested?
N/A
Are there any user-facing changes?