Set doc_md on TaskFlow decorator example DAGs#66443
Set doc_md on TaskFlow decorator example DAGs#66443ColtenOuO wants to merge 1 commit intoapache:mainfrom
Conversation
|
The I followed the existing in-directory convention from example_bash_operator.py (no link) rather than ship dead URLs. Happy to add links in a follow-up once the redirect is fixed. |
|
The failing job Could a maintainer rerun the failed job? Happy to push an empty commit if that's preferred. |
Summary
Closes #60128 by setting
dag.doc_mdon three TaskFlow-decorator example DAGs inproviders/standard/src/airflow/providers/standard/example_dags/. Withoutdoc_md, the DAG's "Docs" tab in the UI is empty, which hurts the first-time-user / onboarding experience these examples are meant to support.The issue body names four examples as a starting set. One of them —
example_bash_decorator.py— already has a function-level docstring, which the@dagdecorator auto-assigns todag.doc_mdwhen no explicitdoc_mdis set, so its Docs tab is already populated and it's intentionally left out of this PR.The remaining three from the issue's starting set are addressed:
example_sensor_decorator.py@dagdecorator, only a module docstringdoc_md)example_short_circuit_decorator.py@dagdecorator, only a module docstringdoc_md)example_branch_operator_decorator.pywith DAG(...)block, module docstringdoc_md=__doc__to theDAG(...)callEach
doc_mdfollows the structure called out in the issue: H3 title, one-paragraph intro, a "What this DAG shows" bulleted list, and a link to the relevant operator/concept docs.Was generative AI tooling used to co-author this PR?
Generated-by: Claude Code following the guidelines