From 9b7bf32f0cda5d3edc954b9891a3e7bad9c00c97 Mon Sep 17 00:00:00 2001 From: Charles d'Avernas Date: Wed, 8 Jan 2025 14:38:13 +0100 Subject: [PATCH] Document the output of a task that defines an non-awaited process Closes #1004 Signed-off-by: Charles d'Avernas --- dsl-reference.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dsl-reference.md b/dsl-reference.md index 92b02d60..4f72ce7c 100644 --- a/dsl-reference.md +++ b/dsl-reference.md @@ -716,13 +716,13 @@ Provides the capability to execute external [containers](#container-process), [s ##### Properties -| Name | Type | Required | Description| +| Name | Type | Required | Description | |:--|:---:|:---:|:---| | run.container | [`container`](#container-process) | `no` | The definition of the container to run.
*Required if `script`, `shell` and `workflow` have not been set.* | | run.script | [`script`](#script-process) | `no` | The definition of the script to run.
*Required if `container`, `shell` and `workflow` have not been set.* | | run.shell | [`shell`](#shell-process) | `no` | The definition of the shell command to run.
*Required if `container`, `script` and `workflow` have not been set.* | | run.workflow | [`workflow`](#workflow-process) | `no` | The definition of the workflow to run.
*Required if `container`, `script` and `shell` have not been set.* | -| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.
*Defaults to `true`.* | +| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.
*When set to `false`, the task cannot wait for the process to complete and thus cannot output the process’s result. In this case, it should simply output its transformed input.*
*Defaults to `true`.* | ##### Examples