Docs: clarify BaseSensorOperator parameters in Sensors guide #60275
+64
−0
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.