Minor: Add more doc strings to WindowExpr #6663
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
physical-expr
r4ntix
approved these changes
Jun 14, 2023
jackwener
reviewed
Jun 14, 2023
datafusion/physical-expr/src/window/built_in_window_function_expr.rs
Outdated
Show resolved
Hide resolved
jackwener
approved these changes
Jun 14, 2023
comphead
reviewed
Jun 14, 2023
| /// 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.
interesting that lag doesn't require explicit ordering, but it works
There was a problem hiding this comment.
Hmm I think the example would be better with an ORDER BY -- I will update it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
More work towards #5781 by incrementally adding docstrings to the relevant
WindowFunctionexpressionsRationale 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
PartitionEvaluatormoreAre these changes tested?
N/A
Are there any user-facing changes?