Minor: Refine doc comments for BuiltinScalarFunction::return_dimension (

#7045)
apache · Jul 26, 2023 · 3542029 · 3542029
1 parent f9a1396
commit 3542029
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/datafusion/expr/src/built_in_function.rs b/datafusion/expr/src/built_in_function.rs
@@ -436,7 +436,15 @@ impl BuiltinScalarFunction {
         )
     }
 
-    /// Returns the dimension [`DataType`] of [`DataType::List`].
+    /// Returns the dimension [`DataType`] of [`DataType::List`] if
+    /// treated as a N-dimensional array.
+    ///
+    /// ## Examples:
+    ///
+    /// * `Int64` has dimension 1
+    /// * `List(Int64)` has dimension 2
+    /// * `List(List(Int64))` has dimension 3
+    /// * etc.
     fn return_dimension(self, input_expr_type: DataType) -> u64 {
         let mut res: u64 = 1;
         let mut current_data_type = input_expr_type;