From 6f8c74ca873fe015b2e7ff4eeb2f76bf21ae9d0e Mon Sep 17 00:00:00 2001 From: jcsherin Date: Sat, 5 Oct 2024 16:43:35 +0530 Subject: [PATCH] Minor: doc how field name is to be set (#12757) --- datafusion/expr/src/udwf.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/datafusion/expr/src/udwf.rs b/datafusion/expr/src/udwf.rs index 6459e8f3f7d1..69f357d48f8c 100644 --- a/datafusion/expr/src/udwf.rs +++ b/datafusion/expr/src/udwf.rs @@ -355,6 +355,10 @@ pub trait WindowUDFImpl: Debug + Send + Sync { } /// The [`Field`] of the final result of evaluating this window function. + /// + /// Call `field_args.name()` to get the fully qualified name for defining + /// the [`Field`]. For a complete example see the implementation in the + /// [Basic Example](WindowUDFImpl#basic-example) section. fn field(&self, field_args: WindowUDFFieldArgs) -> Result; /// Allows the window UDF to define a custom result ordering.