Skip to content

Commit 0f554fa

Browse files
authored
Minor: Improve documentation for AggregateUDFImpl::state_fields (#11740)
* Minor: Improve documentation for AggregateUDFImpl::state_fields * apply review suggestion
1 parent ae2ca6a commit 0f554fa

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

datafusion/expr/src/udaf.rs

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -351,12 +351,8 @@ pub trait AggregateUDFImpl: Debug + Send + Sync {
351351

352352
/// Return the fields used to store the intermediate state of this accumulator.
353353
///
354-
/// # Arguments:
355-
/// 1. `name`: the name of the expression (e.g. AVG, SUM, etc)
356-
/// 2. `value_type`: Aggregate function output returned by [`Self::return_type`] if defined, otherwise
357-
/// it is equivalent to the data type of the first arguments
358-
/// 3. `ordering_fields`: the fields used to order the input arguments, if any.
359-
/// Empty if no ordering expression is provided.
354+
/// args: [`StateFieldsArgs`] contains arguments passed to the
355+
/// aggregate function's accumulator.
360356
///
361357
/// # Notes:
362358
///

0 commit comments

Comments
 (0)