Araragiokio opened a new pull request, #73362:
URL: https://github.com/apache/airflow/pull/73362
This pull request makes several documentation improvements to the Airflow
core concepts related to operators. The changes clarify language, improve
technical accuracy, and enhance references to code and documentation.
Documentation improvements:
* Updated the section header to clarify that ``params`` is a reserved
keyword, and improved the explanation and grammar about its usage in DAG
serialization and third-party operators.
* Improved references to the `pre_execute` and `post_execute` methods by
using Sphinx-style cross-references to their definitions in `BaseOperator`,
enhancing clarity for readers.
* Corrected a code example to use the correct variable name (`tasks_to_skip`
instead of `on_ice`) for checking whether a task should be skipped.
Clarity and accuracy enhancements:
* Reworded the explanation of the `post_execute` method and clarified that
both `pre_execute` and `post_execute` receive the task instance's context as a
parameter.
* Clarified the distinction between `pre_execute`/`post_execute` and
setup/teardown tasks, adding a documentation link for further
reference.…e/post-execute
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
https://chris.beams.io/posts/git-commit/
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.
For user-facing UI changes, please attach before/after screenshots (or a
short
screen recording) so reviewers can assess the visual impact.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
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]
