jaymasiwal opened a new pull request, #60275:
URL: https://github.com/apache/airflow/pull/60275
### 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
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information.
In case of fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party
License Policy](https://www.apache.org/legal/resolved.html#category-x).
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](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
