Skip to content

Commit b5cef9a

Browse files
committed
Minor: Add documentation to AggregateWindowExpr::get_result_column
1 parent a17282f commit b5cef9a

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

datafusion/physical-expr/src/window/window_expr.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ pub struct WindowPhysicalExpressions {
171171
}
172172

173173
/// Extension trait that adds common functionality to [`AggregateWindowExpr`]s
174-
pub trait AggregateWindowExpr: WindowExpr {
174+
pub trait : WindowExpr {
175175
/// Get the accumulator for the window expression. Note that distinct
176176
/// window expressions may return distinct accumulators; e.g. sliding
177177
/// (non-sliding) expressions will return sliding (normal) accumulators.
@@ -263,6 +263,15 @@ pub trait AggregateWindowExpr: WindowExpr {
263263

264264
/// Calculates the window expression result for the given record batch.
265265
/// Assumes that `record_batch` belongs to a single partition.
266+
///
267+
/// # Arguments
268+
/// * `accumulator`: The accumulator to use for the calculation.
269+
/// * `record_batch`: batch belonging to the current partition (see [`PartitionBatchState`]).
270+
/// * `most_recent_row`: the batch that contains the most recent row, if available (see [`PartitionBatchState`]).
271+
/// * `last_range`: The last range of rows that were processed (see [`WindowAggState`]).
272+
/// * `window_frame_ctx`: Details about the window frame (see [`WindowFrameContext`]).
273+
/// * `idx`: The index of the current row in the record batch.
274+
/// * `not_end`: is the current row not the end of the partition (see [`PartitionBatchState`]).
266275
#[allow(clippy::too_many_arguments)]
267276
fn get_result_column(
268277
&self,

0 commit comments

Comments
 (0)