Skip to content

Minor: Remove wrong comment on Accumulator::evaluate and Accumulator::state #12001

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.

Sign up for GitHub

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

Merged
comphead merged 4 commits into from
Aug 16, 2024
Merged

Minor: Remove wrong comment on Accumulator::evaluate and Accumulator::state #12001

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a5c3c84
Remove wrong comment
lewiszlw Aug 15, 2024
7603055
Remove wrong comment on Accumulator::state
lewiszlw Aug 15, 2024
6d79900
Not call twice comment
lewiszlw Aug 16, 2024
8e6646c
Adjust comment order
lewiszlw Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions datafusion/expr-common/src/accumulator.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ pub trait Accumulator: Send + Sync + Debug {
/// 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
Copy link
Copy Markdown
Contributor

@alamb alamb Aug 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Contributor

@comphead comphead Aug 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree concise documentation is quite important. Especially when DF becoming more feature rich and code is evolving

Copy link
Copy Markdown
Member Author

@lewiszlw lewiszlw Aug 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added "Not call twice" comment. Feel free to help me polish comment wording.

/// equivalent to when it was first created.
/// This function should not be called twice, otherwise it will
/// result in potentially non-deterministic behavior.
///
/// This function gets `&mut self` to allow for the accumulator to build
/// arrow compatible internal state that can be returned without copying
Expand All @@ -85,8 +85,8 @@ pub trait Accumulator: Send + Sync + Debug {
/// Returns the intermediate state of the accumulator, consuming the
/// intermediate state.
///
/// After this call, the accumulator's internal state should be
/// equivalent to when it was first created.
/// This function should not be called twice, otherwise it will
/// result in potentially non-deterministic behavior.
///
/// This function gets `&mut self` to allow for the accumulator to build
/// arrow compatible internal state that can be returned without copying
Expand Down