Minor: Clarify usecase for LogicalPlan::recompute_schema (apache#10443

)
findepi · Jul 16, 2024 · dfa6063 · dfa6063
1 parent 4e003b7
commit dfa6063
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/datafusion/expr/src/logical_plan/plan.rs b/datafusion/expr/src/logical_plan/plan.rs
@@ -479,6 +479,11 @@ impl LogicalPlan {
     /// expressions. For example [`LogicalPlan::Filter`] schema is always the
     /// same as its input schema.
     ///
+    /// This is useful after modifying a plans `Expr`s (or input plans) via
+    /// methods such as [Self::map_children] and [Self::map_expressions]. Unlike
+    /// [Self::with_new_exprs], this method does not require a new set of
+    /// expressions or inputs plans.
+    ///
     /// # Return value
     /// Returns an error if there is some issue recomputing the schema.
     ///