Add on failure node passing err message doc (#6209)

* amend doc Signed-off-by: Alex Wu <[email protected]> * fix doc reference code lines Signed-off-by: Alex Wu <[email protected]> --------- Signed-off-by: Alex Wu <[email protected]>
flyteorg · Feb 12, 2025 · d3a34ed · d3a34ed
1 parent 592f1c4
commit d3a34ed
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/docs/user_guide/development_lifecycle/failure_node.md b/docs/user_guide/development_lifecycle/failure_node.md
@@ -22,14 +22,14 @@ To clone and run the example code on this page, see the [Flytesnacks repo][flyte
 
 ```{literalinclude} /examples/development_lifecycle/development_lifecycle/failure_node.py
 :caption: development_lifecycle/failure_node.py
-:lines: 1-6
+:lines: 1-7
 ```
 
 Create a task that will fail during execution:
 
 ```{literalinclude} /examples/development_lifecycle/development_lifecycle/failure_node.py
 :caption: development_lifecycle/failure_node.py
-:lines: 10-18
+:lines: 11-19
 ```
 
 Create a task that will be executed if any of the tasks in the workflow fail:
@@ -42,7 +42,8 @@ Create a task that will be executed if any of the tasks in the workflow fail:
 Specify the `on_failure` to a cleanup task. This task will be executed if any of the tasks in the workflow fail:
 
 :::{note}
-The input of `clean_up` should be the exact same as the input of the workflow.
+The inputs of `clean_up` must exactly match the workflow's inputs. Additionally, the `err` parameter will be 
+populated with the error message encountered during execution.
 :::
 
 ```{literalinclude} /examples/development_lifecycle/development_lifecycle/failure_node.py
@@ -54,7 +55,7 @@ By setting the failure policy to `FAIL_AFTER_EXECUTABLE_NODES_COMPLETE` to ensur
 
 ```{literalinclude} /examples/development_lifecycle/development_lifecycle/failure_node.py
 :caption: development_lifecycle/failure_node.py
-:lines: 42-53
+:lines: 43-54
 ```
 
 You can also set the `on_failure` to a workflow. This workflow will be executed if any of the tasks in the workflow fail: