Skip to content

Commit

Permalink
Minor: doc how field name is to be set (#12757)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcsherin authored Oct 5, 2024
1 parent 862bb4a commit 6f8c74c
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions datafusion/expr/src/udwf.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 6f8c74c

Please sign in to comment.