This is an automated email from the ASF dual-hosted git repository.
linwei pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 0f554fa124 Minor: Improve documentation for
AggregateUDFImpl::state_fields (#11740)
0f554fa124 is described below
commit 0f554fa12490ffa72c3c6ca42186c1ac9461bfa6
Author: 张林伟 <[email protected]>
AuthorDate: Thu Aug 1 11:06:55 2024 +0800
Minor: Improve documentation for AggregateUDFImpl::state_fields (#11740)
* Minor: Improve documentation for AggregateUDFImpl::state_fields
* apply review suggestion
---
datafusion/expr/src/udaf.rs | 8 ++------
1 file changed, 2 insertions(+), 6 deletions(-)
diff --git a/datafusion/expr/src/udaf.rs b/datafusion/expr/src/udaf.rs
index af964b6154..f5eeef6b53 100644
--- a/datafusion/expr/src/udaf.rs
+++ b/datafusion/expr/src/udaf.rs
@@ -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:
///
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
