ColtenOuO opened a new pull request, #66443:
URL: https://github.com/apache/airflow/pull/66443

   ## Summary
   
   Closes #60128 by setting `dag.doc_md` on three TaskFlow-decorator example 
DAGs in `providers/standard/src/airflow/providers/standard/example_dags/`. 
Without `doc_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 
[`@dag` decorator auto-assigns to 
`dag.doc_md`](task-sdk/src/airflow/sdk/definitions/dag.py#L1655-L1657) when no 
explicit `doc_md` is 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:
   
   | File | Pattern | Change |
   |---|---|---|
   | `example_sensor_decorator.py` | `@dag` decorator, only a module docstring 
| Added a function docstring (auto-flows into `doc_md`) |
   | `example_short_circuit_decorator.py` | `@dag` decorator, only a module 
docstring | Added a function docstring (auto-flows into `doc_md`) |
   | `example_branch_operator_decorator.py` | `with DAG(...)` block, module 
docstring | Restructured the existing module docstring as Markdown and passed 
`doc_md=__doc__` to the `DAG(...)` call |
   
   Each `doc_md` follows 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?
   
   - [X] Yes (Claude Code) for grammar correction
   
   Generated-by: Claude Code following [the 
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)


-- 
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]

Reply via email to