docs: Document WindowFn and add comments - #24118
Open
alamb wants to merge 6 commits into
Open
Conversation
alamb
force-pushed
the
alamb/document-window-fn
branch
from
August 5, 2026 19:43
b7418cb to
69c5f08
Compare
alamb
changed the title
WindowFn and its variantsWindowFn to WindowFnState and add comments
alamb
force-pushed
the
alamb/document-window-fn
branch
from
August 5, 2026 19:46
69c5f08 to
eaa18f9
Compare
alamb
changed the title
WindowFn to WindowFnState and add commentsWindowFn and add comments
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
alamb
force-pushed
the
alamb/document-window-fn
branch
from
August 5, 2026 19:48
eaa18f9 to
f368ba0
Compare
alamb
commented
Aug 5, 2026
| /// State for incrementally evaluating a window function | ||
| /// within a partition, created by [`WindowExpr::create_window_fn`]. | ||
| #[derive(Debug)] | ||
| pub enum WindowFn { |
Contributor
Author
There was a problem hiding this comment.
This struct is not technically pub as it is in a mod (not `pub mod), though it somehow appears in the WindowExpr trait 🤷
It might be nice to fix the naming but I think for now just documenting it is helpful
alamb
changed the title
WindowFn and add commentsWindowFn and add comments
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #24118 +/- ##
==========================================
- Coverage 81.14% 81.14% -0.01%
==========================================
Files 1110 1110
Lines 386137 386137
Branches 386137 386137
==========================================
- Hits 313347 313334 -13
- Misses 54324 54335 +11
- Partials 18466 18468 +2 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
github-actions
Bot
removed
the
documentation
nuno-faria
approved these changes
Aug 12, 2026
nuno-faria
left a comment
nuno-faria
left a comment
Contributor
There was a problem hiding this comment.
Thanks @alamb, LGTM. One question: here "partition" refers to the logical partitions of the window function and not concurrency partitions right?
Comment on lines
+618
to
+619
| /// [`PartitionEvaluator`]. Despite the name, it is used for all window | ||
| /// function that is not an aggregate function. |
Contributor
There was a problem hiding this comment.
nit: "... for all window function that is not aggregate function" -> "for all window functions that are not aggregate functions"?
alamb
enabled auto-merge
August 12, 2026 21:28
Contributor
Author
|
Thank you for the review @nuno-faria |
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Aug 12, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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?
Rationale for this change
The
WindowFnenum indatafusion-physical-exprhas no documentation, and itsBuiltinvariant name is misleading:What changes are included in this PR?
Doc comments on
WindowFnand its two variants, including links to theWindowExprimplementations that create each variant.Are these changes tested?
By CI
Are there any user-facing changes?
Improved API documentation only; no code changes.