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

   Follow-up to #66257 addressing the [post-merge 
review](https://github.com/apache/airflow/pull/66257#pullrequestreview-4259464331)
 from @jscheffl. His comment landed after the merge, so the items below were 
not part of the original PR. Drafting this for visibility while I wait on 
guidance for the consolidation item.
   
   What this PR covers from Jens' list:
   
   - **Dag Markdown Documentation**: both example Dags now define a ``doc_md`` 
block that renders in the UI with the storyline, the per-step description, and 
a link back to the example Dag review checklist.
   - **Pydoc at the task level**: every task (TaskFlow and ``PythonOperator``) 
now has a docstring explaining what it does and how it would map to a 
production pipeline.
   - **Take the new example into the docs**: the example Dag review checklist 
(``contributing-docs/28_example_dag_review_checklist.rst``) now references both 
files as the canonical templates for new tutorial-style example Dags.
   
   What is **not** in this PR (need your input, @jscheffl):
   
   - **Consolidating / removing pre-existing artificial examples**. The 
standard provider has ``example_python_decorator.py`` / 
``example_python_operator.py`` that overlap conceptually with the measurement 
correction ones, but ``providers/standard/docs/operators/python.rst`` 
references them ~12 times as ``exampleinclude`` targets, so they are not free 
to delete. Could you point me at which pre-existing example(s) you had in mind 
so I can replace them in a separate commit on this branch?
   
   ---
   
   ##### Was generative AI tooling used to co-author this PR?
   
   - [ ] Yes


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