Skip to content

Improve custom task decorator docs#67306

Open
Will-thom wants to merge 1 commit into
apache:mainfrom
Will-thom:airflow-33167-custom-decorator-docs
Open

Improve custom task decorator docs#67306
Will-thom wants to merge 1 commit into
apache:mainfrom
Will-thom:airflow-33167-custom-decorator-docs

Conversation

@Will-thom
Copy link
Copy Markdown

Closes #33167.

This updates the custom TaskFlow decorator how-to so it reads more like a tutorial:

  • explains when a provider-level @task. decorator is appropriate
  • shows the decorated operator and factory function pieces separately
  • documents provider.yaml as the source for task-decorators metadata in this repository
  • keeps get_provider_info guidance for third-party providers

Validation:

  • git diff --cached --check
  • parsed the RST with docutils for basic structure; Sphinx-specific Airflow roles/directives are not available in plain docutils

@boring-cyborg
Copy link
Copy Markdown

boring-cyborg Bot commented May 21, 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
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 potiuk added the ready for maintainer review Set after triaging when all criteria pass. label May 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation ready for maintainer review Set after triaging when all criteria pass.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

unclear docs on custom decorators

2 participants