potiuk commented on code in PR #69791: URL: https://github.com/apache/airflow/pull/69791#discussion_r4175746046
########## airflow-core/docs/howto/task-group.rst: ########## @@ -0,0 +1,35 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Organizing tasks with TaskGroups +--------------------------------- + +When a Dag has many related tasks, you can group them visually using +:class:`~airflow.sdk.TaskGroup`. This keeps the Graph view readable and +lets you organize tasks into logical sections, including nested groups. + +.. exampleinclude:: /../src/airflow/example_dags/example_task_group.py + :language: python + :start-after: [START howto_task_group_section_1] + :end-before: [END howto_task_group_section_1] Review Comment: The included snippets leave out `start >> section_1 >> section_2 >> end`. That line shows the most useful behaviour: a dependency on a group applies to its root/leaf tasks. The existing `howto_task_group` marker pair already covers the whole Dag. --- Drafted-by: Claude Code (Opus 5); reviewed by @potiuk before posting ########## airflow-core/docs/howto/task-group.rst: ########## @@ -0,0 +1,35 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Organizing tasks with TaskGroups +--------------------------------- + +When a Dag has many related tasks, you can group them visually using +:class:`~airflow.sdk.TaskGroup`. This keeps the Graph view readable and +lets you organize tasks into logical sections, including nested groups. + +.. exampleinclude:: /../src/airflow/example_dags/example_task_group.py + :language: python + :start-after: [START howto_task_group_section_1] + :end-before: [END howto_task_group_section_1] + +TaskGroups can also be nested inside one another: + +.. exampleinclude:: /../src/airflow/example_dags/example_task_group.py + :language: python + :start-after: [START howto_task_group_section_2] + :end-before: [END howto_task_group_section_2] Review Comment: This include will render the nested `# [START howto_task_group_inner_section_2]` / `# [END ...]` comments verbatim, because `exampleinclude` doesn't strip markers. Nothing else uses those inner markers, so they can be removed from the example. --- Drafted-by: Claude Code (Opus 5); reviewed by @potiuk before posting ########## airflow-core/docs/howto/index.rst: ########## @@ -60,3 +60,4 @@ configuring an Airflow environment. run-with-self-signed-certificate performance memory-profiling + task-group Review Comment: Please place the page near the other Dag-authoring how-tos rather than after `memory-profiling`. --- Drafted-by: Claude Code (Opus 5); reviewed by @potiuk before posting -- 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]
