Skip to content

Standardize example DAG docs via module docstring #61481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jadecodelab wants to merge 4 commits into
base: main
Choose a base branch
from
+30 −16
Open

Standardize example DAG docs via module docstring #61481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4acbc1b
Add doc_md to example_bash_decorator DAG
jadecodelab Jan 15, 2026
23cd1be
erge branch 'main' of https://github.com/apache/airflow
jadecodelab Jan 16, 2026
ccd3de6
Merge branch 'main' of https://github.com/apache/airflow
jadecodelab Feb 5, 2026
db47213
Use module docstring for Bash example DAG docs
jadecodelab Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion providers/standard/src/airflow/providers/standard/example_dags/example_bash_decorator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@
# specific language governing permissions and limitations
# under the License.

"""
### Bash Decorator Example

This example DAG demonstrates how to use the `@task.bash` decorator
to define tasks that execute Bash commands in Apache Airflow.

It shows:
- Creating Bash tasks using the TaskFlow API
- Passing parameters to Bash commands
- Basic task execution within a decorator-based DAG

This DAG is intended for learning and demonstration purposes.
"""
from __future__ import annotations

import pendulum
Expand All @@ -26,7 +39,7 @@
from airflow.sdk.exceptions import AirflowSkipException


@dag(schedule=None, start_date=pendulum.datetime(2023, 1, 1, tz="UTC"), catchup=False)
@dag(schedule=None, start_date=pendulum.datetime(2023, 1, 1, tz="UTC"), catchup=False, doc_md=__doc__,)
def example_bash_decorator():
@task.bash
def run_me(sleep_seconds: int, task_instance_key_str: str) -> str:
Expand Down
31 changes: 16 additions & 15 deletions providers/standard/src/airflow/providers/standard/example_dags/example_bash_operator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,21 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""Example DAG demonstrating the usage of the BashOperator."""

"""
### Example BashOperator DAG

This example DAG demonstrates how to use the **BashOperator** to execute shell commands
as part of an Apache Airflow workflow.

**What this DAG shows:**
- Defining tasks using `BashOperator`
- Executing simple bash commands
- Creating task dependencies, including loops and templated commands

This example is intended for beginners who want to understand how Airflow
interacts with system-level commands using bash.
"""

from __future__ import annotations

Expand All @@ -36,20 +50,7 @@
tags=["example", "example2"],
params={"example_key": "example_value"},
) as dag:
dag.doc_md = """
### Example BashOperator DAG

This DAG demonstrates how to use the **BashOperator** to execute shell commands
as part of an Apache Airflow workflow.

**What this DAG shows:**
- Defining tasks using `BashOperator`
- Executing simple bash commands
- Creating task dependencies, including loops and templated commands

This example is intended for beginners who want to understand how Airflow
interacts with system-level commands using bash.
"""
doc_md=__doc__,

run_this_last = EmptyOperator(
task_id="run_this_last",
Expand Down