Skip to content

Improve custom decorator documentation#64018

Open
Topgearfanboy wants to merge 3 commits intoapache:mainfrom
Topgearfanboy:main
Open

Improve custom decorator documentation#64018
Topgearfanboy wants to merge 3 commits intoapache:mainfrom
Topgearfanboy:main

Conversation

@Topgearfanboy
Copy link
Copy Markdown

Update the docs to better describe customer decorators as described in issue #33167


Was generative AI tooling used to co-author this PR?
  • Yes (please specify the tool below)

Partially Generated-by: Windsurf IDE following the guidelines


  • Read the 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) is needed.
  • When adding dependency, check compliance with the ASF 3rd Party License Policy.
  • For significant user-facing changes create newsfragment: {pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.

Note: This is my first ever PR to a public repo so if i missed any instructions please let me know. Thanks!

@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented Mar 20, 2026

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@potiuk
Copy link
Copy Markdown
Member

potiuk commented Mar 22, 2026

@Topgearfanboy This PR has a few issues that need to be addressed before it can be reviewed — please see our Pull Request quality criteria.

Issues found:

  • Pre-commit / static checks: Failing: CI image checks / Static checks. Run prek run --from-ref main locally to find and fix issues. See Pre-commit / static checks docs.

What to do next:

  • The comment informs you what you need to do.
  • Fix each issue, then mark the PR as "Ready for review" in the GitHub UI - but only after making sure that all the issues are fixed.
  • There is no rush — take your time and work at your own pace. We appreciate your contribution and are happy to wait for updates.
  • Maintainers will then proceed with a normal review.

There is no rush — take your time and work at your own pace. We appreciate your contribution and are happy to wait for updates. If you have questions, feel free to ask on the Airflow Slack.

@Topgearfanboy
Copy link
Copy Markdown
Author

Hey @potiuk I ran the tests locally and they are passing. I think it just had gotten out of sync with the official repo but i have rectified that so I think it should be good now. If I am missing something please let me know. Thanks!

@vurgunhajiyev
Copy link
Copy Markdown

Description

This PR improves the documentation for custom decorators in Apache Airflow based on issue #33167.

The goal is to make the usage and behavior of custom decorators clearer and easier to understand. The changes focus on improving wording, removing ambiguity, and aligning the documentation with actual usage patterns.

Changes

  • Improved clarity of custom decorator explanations
  • Refined wording for better readability
  • Minor corrections and consistency updates

Impact

Enhances developer experience by making documentation more intuitive, especially for users working with DAG customization.

Notes

This is an initial contribution — happy to iterate based on feedback.

Partially Generated-by: Windsurf IDE

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.

3 participants