Skip to content

Commit ee01acf

Browse files
niebayesadriangb
andauthored
fix: update comment on FilterPushdownPropagation (#20040)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> No ## Rationale for this change <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> I think the original comment is misleading as we actually want to express if a parent filter was pushed down to any child successfully. ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> Updated the comment about the `filters` in the `FilterPushdownPropagation` struct. ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> No need to test as it only modifies comments. ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> Yes, but only touches the comment. --------- Co-authored-by: Adrian Garcia Badaracco <1755071+adriangb@users.noreply.github.com>
1 parent 1799c31 commit ee01acf

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

datafusion/physical-plan/src/filter_pushdown.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,13 +221,13 @@ pub struct ChildPushdownResult {
221221
/// Returned from [`ExecutionPlan::handle_child_pushdown_result`] to communicate
222222
/// to the optimizer:
223223
///
224-
/// 1. What to do with any parent filters that were could not be pushed down into the children.
224+
/// 1. What to do with any parent filters that could not be pushed down into the children.
225225
/// 2. If the node needs to be replaced in the execution plan with a new node or not.
226226
///
227227
/// [`ExecutionPlan::handle_child_pushdown_result`]: crate::ExecutionPlan::handle_child_pushdown_result
228228
#[derive(Debug, Clone)]
229229
pub struct FilterPushdownPropagation<T> {
230-
/// What filters were pushed into the parent node.
230+
/// Which parent filters were pushed down into this node's children.
231231
pub filters: Vec<PushedDown>,
232232
/// The updated node, if it was updated during pushdown
233233
pub updated_node: Option<T>,

0 commit comments

Comments
 (0)