Minor: Add some more doc comments to BoundedAggregateStream
#6881
Conversation
This file contains 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
alamb
commented
Jul 7, 2023
| &mut self, | ||
| group_values: &[ArrayRef], | ||
| per_group_indices: Vec<GroupOrderInfo>, | ||
| per_group_order_info: Vec<GroupOrderInfo>, |
There was a problem hiding this comment.
I found the old name 'group_indices` confusing here as it is not just indices
alamb
commented
Jul 7, 2023
| @@ -348,29 +355,29 @@ impl BoundedAggregateStream { | |||
|
|
|||
| let AggregationState { | |||
| map: row_map, | |||
| ordered_group_states: row_group_states, | |||
| ordered_group_states, | |||
There was a problem hiding this comment.
made local variable match struct field name
alamb
force-pushed
the
alamb/doc_streaming_gby
branch
from
8b81452 to
853869b
Compare
alamb
force-pushed
the
alamb/doc_streaming_gby
branch
from
853869b to
6bb71b4
Compare
mustafasrepo
approved these changes
Jul 10, 2023
Co-authored-by: Mustafa Akur <[email protected]>
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?
Related to #6798
Rationale for this change
I am working on reducing the duplication between the grouping operators (streams) by combining them. The first step of this is for me to understand what they do, and I wanted to encode this understanding as doc comments.
What changes are included in this PR?
Are these changes tested?
existing tests
Are there any user-facing changes?
No