Minor: Remove wrong comment on Accumulator::evaluate and Accumulator::state#12001
Merged
comphead merged 4 commits intoapache:mainfrom Aug 16, 2024
Merged
Minor: Remove wrong comment on Accumulator::evaluate and Accumulator::state#12001comphead merged 4 commits intoapache:mainfrom
Accumulator::evaluate and Accumulator::state#12001comphead merged 4 commits intoapache:mainfrom
Conversation
lewiszlw
changed the title
Accumulator::evaluateAccumulator::evaluate and Accumulator::state
Contributor
|
I guess although it is not cleanup (the state is different), but it is also "not used" after all 🤔 |
Member
Author
|
I guess the author may want to reuse accumulator after call, but actually not. |
alamb
reviewed
Aug 15, 2024
| /// For example, the `SUM` accumulator maintains a running sum, | ||
| /// and `evaluate` will produce that running sum as its output. | ||
| /// | ||
| /// After this call, the accumulator's internal state should be |
Contributor
There was a problem hiding this comment.
I think it would be better update the docs to explain what the state can be after calling the function rather than simply removing the docs.
For example, is it the case that
- "calling evaluate twice should result in an error"?
- "calling evaluate twice will result in potentially non deterministic behavior"?
- Something else?
Contributor
There was a problem hiding this comment.
Agree concise documentation is quite important. Especially when DF becoming more feature rich and code is evolving
Member
Author
There was a problem hiding this comment.
Added "Not call twice" comment. Feel free to help me polish comment wording.
alamb
approved these changes
Aug 16, 2024
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
4 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?
I checked some
Accumulatorimplementations, they all won't clear internal state afterevaluateorstatecall.Rationale for this change
What changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?