Minor: doc how field name is to be set (#12757)

jcsherin · web-flow · commit 6f8c74ca873f · 2024-10-05T07:13:35.000-04:00
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -355,6 +355,10 @@ pub trait WindowUDFImpl: Debug + Send + Sync {`
`355`	`355`	`}`
`356`	`356`
`357`	`357`	/// The [`Field`] of the final result of evaluating this window function.
	`358`	`+ ///`
	`359`	+ /// Call `field_args.name()` to get the fully qualified name for defining
	`360`	+ /// the [`Field`]. For a complete example see the implementation in the
	`361`	`+ /// [Basic Example](WindowUDFImpl#basic-example) section.`
`358`	`362`	`fn field(&self, field_args: WindowUDFFieldArgs) -> Result<Field>;`
`359`	`363`
`360`	`364`	`/// Allows the window UDF to define a custom result ordering.`