Skip to content

Conversation

@jaymasiwal
Copy link
Contributor

What this PR does

The core Sensors documentation did not clearly document parameters inherited from
BaseSensorOperator (e.g. poke_interval, timeout, mode, soft_fail), and
there 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:

  • Explains that all sensors inherit from BaseSensorOperator
  • Documents commonly used sensor parameters in one place
  • Links to the authoritative Task SDK API reference
  • Includes a short example showing typical usage

Why this is needed

Because BaseSensorOperator now lives in the Task SDK, provider API pages do not
always 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

  • Documentation only
  • No code or behavior changes

^ 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.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

@jaymasiwal
Copy link
Contributor Author

All checks are green now. Happy to adjust wording or structure if reviewers have suggestions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant