You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by al...@apache.org on 2024/10/05 11:13:39 UTC

(datafusion) branch main updated: Minor: doc how field name is to be set (#12757)

This is an automated email from the ASF dual-hosted git repository.

alamb 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 6f8c74ca87 Minor: doc how field name is to be set (#12757)
6f8c74ca87 is described below

commit 6f8c74ca873fe015b2e7ff4eeb2f76bf21ae9d0e
Author: jcsherin <ja...@protoship.io>
AuthorDate: Sat Oct 5 16:43:35 2024 +0530

    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 6459e8f3f7..69f357d48f 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<Field>;
 
     /// Allows the window UDF to define a custom result ordering.


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org