Fix reversed direction examples in FanOutMapper docs#69313
Open
Lee-W wants to merge 1 commit into
Open
Conversation
The FanOutMapper docstrings in core and the Task SDK both described Window.Direction.FORWARD as producing a trailing/next period, but FORWARD (the default) actually yields the period starting at the upstream key; BACKWARD yields the trailing period ending at it. Both copies are corrected and now match each other.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Window.Direction.FORWARD(the default) yields the period starting at the upstream key — the period it represents — whileBACKWARDyields the trailing period ending at the key. The docstrings described it the other way around: they claimedFORWARDproduced the trailing/"next" period, and the code examples setdirection=Window.Direction.FORWARDto get the trailing window. An author following either docstring would pick the opposite direction from what they intended.What
airflow-core/src/airflow/partition_mappers/temporal.pyandtask-sdk/src/airflow/sdk/definitions/partition_mappers/temporal.pyto state thatFORWARDstarts at the upstream key andBACKWARDtrails it.Window.Direction.BACKWARDfor the trailing period, and corrected the accompanying comments (e.g. "the 7 days the upstream Monday represents" vs. "the 7 days ending at the upstream Monday").Was generative AI tooling used to co-author this PR?
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.