Skip to content

Commit

Permalink
Minor: Improve documentation for AggregateUDFImpl::state_fields (#11740)
Browse files Browse the repository at this point in the history
* Minor: Improve documentation for AggregateUDFImpl::state_fields

* apply review suggestion
  • Loading branch information
lewiszlw authored Aug 1, 2024
1 parent ae2ca6a commit 0f554fa
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions datafusion/expr/src/udaf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -351,12 +351,8 @@ pub trait AggregateUDFImpl: Debug + Send + Sync {

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

0 comments on commit 0f554fa

Please sign in to comment.