Apache DataFusion SQL Query Engine
docs: revise OptimizerRule trait method descriptions (#22582)
Gunther Xingae0c539a69bc
diff --git a/docs/source/library-user-guide/working-with-exprs.md b/docs/source/library-user-guide/working-with-exprs.mdindex 472ab24813..2f15fa9061 100644--- a/docs/source/library-user-guide/working-with-exprs.md+++ b/docs/source/library-user-guide/working-with-exprs.md@@ -167,7 +167,7 @@ In DataFusion, an `OptimizerRule` is a trait that supports rewriting `Expr`s thaWe'll call our rule `AddOneInliner` and implement the `OptimizerRule` trait. The `OptimizerRule` trait has two methods:- `name` - returns the name of the rule-- `try_optimize` - takes a `LogicalPlan` and returns an `Option<LogicalPlan>`. If the rule is able to optimize the plan, it returns `Some(LogicalPlan)` with the optimized plan. If the rule is not able to optimize the plan, it returns `None`.+- `rewrite` - takes a `LogicalPlan` and `&dyn OptimizerConfig`, and returns a `Result<Transformed<LogicalPlan>>`. If the rule is able to optimize the plan, it returns `Transformed::yes` with the optimized plan. If the rule is not able to optimize the plan, it returns `Transformed::no`.```rustuse std::sync::Arc;