alamb opened a new pull request, #26479: URL: https://github.com/apache/datafusion/pull/26479
## Which issue does this PR close? - Part of https://github.com/apache/datafusion/pull/26351 (split out so it can be reviewed and merged independently) ## Rationale for this change While reviewing #26351 we noted that `EnsureRequirements` is special among the physical optimizer rules: it is what turns the initial, unexecutable physical plan into one whose distribution and ordering requirements are satisfied. Omitting it, or placing it wrongly in a custom pipeline, can produce a plan that is not runnable or returns incorrect results. That fact was not documented on the rule itself, so projects that build custom optimizer pipelines had no easy way to discover it. ## What changes are included in this PR? Documentation only, in `datafusion/physical-optimizer/src/ensure_requirements/mod.rs`: - Adds a "Placement in the Optimizer Pipeline" section to the module docs explaining why this rule is required and what happens if a pipeline omits it - Expands the `EnsureRequirements` struct docs to name the `ExecutionPlan` methods whose requirements it enforces ## What is the testing strategy for this PR? No tests: documentation only. `cargo doc -p datafusion-physical-optimizer` passes with `RUSTDOCFLAGS="-D warnings"`, so all intra-doc links resolve. ## Are there any user-facing changes? No, only rustdoc text. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
