fix doc

Signed-off-by: guojidan <[email protected]>
guojidan · May 19, 2024 · eddee4d · eddee4d
1 parent 0fdf8e8
commit eddee4d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/...es/examples/simplifier_udwf_expression.rs → ...ples/examples/simplify_udwf_expression.rs b/...es/examples/simplifier_udwf_expression.rs → ...ples/examples/simplify_udwf_expression.rs
diff --git a/datafusion/expr/src/udwf.rs b/datafusion/expr/src/udwf.rs
@@ -285,12 +285,14 @@ pub trait WindowUDFImpl: Debug + Send + Sync {
     /// optimizations manually for specific UDFs.
     ///
     /// Example:
-    /// [`advanced_udwf.rs`]: <https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs>
+    /// [`simplify_udwf_expression.rs`]: <https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/simplify_udwf_expression.rs>
     ///
     /// # Returns
-    /// [`ExprSimplifyResult`] indicating the result of the simplification NOTE
-    /// if the function cannot be simplified, the arguments *MUST* be returned
-    /// unmodified
+    /// [None] if simplify is not defined or,
+    /// 
+    /// Or, a closure with two arguments:
+    /// * 'window_function': [crate::expr::WindowFunction] for which simplified has been invoked
+    /// * 'info': [crate::simplify::SimplifyInfo]
     fn simplify(&self) -> Option<WindowFunctionSimplification> {
         None
     }