From 02a66a3701f07b00cd237c495c197d3d139eed91 Mon Sep 17 00:00:00 2001 From: Jeffrey Wan Date: Mon, 14 Mar 2022 14:54:05 -0400 Subject: [PATCH] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 31439e6..225687d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Description An opinionated implementation of exclusively using airflow DockerOperators for all Operators. +In the following examples, the `Task Code` section is the actual code contained in the image used in the `Dag Code` section. + Default Operator ---------------- @@ -66,6 +68,8 @@ from airflow_docker_helper import client client.branch_to_tasks(['task1', 'task2']) ``` +where 'task1' and 'task2' reference the `task_id` of tasks in the Dag itself. + Short Circuit Operator ---------------------- @@ -88,6 +92,8 @@ from airflow_docker_helper import client client.short_circuit() # This task will short circuit if this function gets called ``` +This will skip all downstream tasks + Context Usage -------------