Skip to content

Commit

Permalink
Clarify docstring on override_last_pushdown_state method
Browse files Browse the repository at this point in the history
  • Loading branch information
tlento committed Jun 26, 2024
1 parent 493a921 commit 036cdb2
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions metricflow/dataflow/optimizer/predicate_pushdown_optimizer.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,12 @@ def override_last_pushdown_state(self, pushdown_state: PredicatePushdownState) -
"""Method for forcibly updating the last seen predicate pushdown state to a new value.
This is necessary only for cases where we wish to back-propagate some updated state attribute
for handling in the exit condition of the preceding node in the DAG. Since it is something of an
extraordinary circumstance we designate it as a special method rather than making it a property setter.
for handling in the exit condition of the preceding node in the DAG. The scenario where we use
this here is for indicating that a where filter has been applied elsewhere on the branch, and so
outer nodes can skip application as appropriate.
Since this is not something we want people doing by accident we designate it as a special method
rather than making it a property setter.
"""
self._current_branch_state[-1] = pushdown_state

Expand Down

0 comments on commit 036cdb2

Please sign in to comment.