Docs: clarify BaseSensorOperator parameters in Sensors guide#60275
Merged
potiuk merged 1 commit intoapache:mainfrom Jan 21, 2026
Merged
Docs: clarify BaseSensorOperator parameters in Sensors guide#60275potiuk merged 1 commit intoapache:mainfrom
potiuk merged 1 commit intoapache:mainfrom
Conversation
Contributor
Author
|
All checks are green now. Happy to adjust wording or structure if reviewers have suggestions. |
potiuk
approved these changes
Jan 21, 2026
potiuk
added
the
backport-to-v3-1-test
Backport successfully created: v3-1-test
|
github-actions bot
pushed a commit
to aws-mwaa/upstream-to-airflow
that referenced
this pull request
Jan 21, 2026
…ide (apache#60275) (cherry picked from commit 928d5b4) Co-authored-by: jaymasiwal <93549457+jaymasiwal@users.noreply.github.com>
jason810496
pushed a commit
to jason810496/airflow
that referenced
this pull request
Jan 22, 2026
amoghrajesh
pushed a commit
to astronomer/airflow
that referenced
this pull request
Jan 22, 2026
suii2210
pushed a commit
to suii2210/airflow
that referenced
this pull request
Jan 26, 2026
ephraimbuddy
pushed a commit
that referenced
this pull request
Jan 27, 2026
(cherry picked from commit 928d5b4)
shreyas-dev
pushed a commit
to shreyas-dev/airflow
that referenced
this pull request
Jan 29, 2026
jhgoebbert
pushed a commit
to jhgoebbert/airflow_Owen-CH-Leung
that referenced
this pull request
Feb 8, 2026
choo121600
pushed a commit
to choo121600/airflow
that referenced
this pull request
Feb 22, 2026
Subham-KRLX
pushed a commit
to Subham-KRLX/airflow
that referenced
this pull request
Mar 4, 2026
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
3 participants
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.
What this PR does
The core Sensors documentation did not clearly document parameters inherited from
BaseSensorOperator(e.g.poke_interval,timeout,mode,soft_fail), andthere was no obvious link to where these parameters are defined after the Task SDK
refactor.
This PR adds a dedicated “BaseSensorOperator parameters” section to the
Sensors guide that:
BaseSensorOperatorWhy this is needed
Because
BaseSensorOperatornow lives in the Task SDK, provider API pages do notalways expose inherited parameters clearly. This makes it unnecessarily hard for
users to discover and understand how sensors behave.
This change improves discoverability without altering any runtime behavior.
Scope
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in airflow-core/newsfragments.