diff options
Diffstat (limited to 'docs/yaml/functions/assert.yaml')
| -rw-r--r-- | docs/yaml/functions/assert.yaml | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/yaml/functions/assert.yaml b/docs/yaml/functions/assert.yaml new file mode 100644 index 000000000..bd64f0113 --- /dev/null +++ b/docs/yaml/functions/assert.yaml @@ -0,0 +1,17 @@ +name: assert +returns: void +description: Abort with an error message if `condition` evaluates to `false`. + +notes: + - The `message` argument is optional since 0.53.0 and defaults to print + the condition statement. + +posargs: + condition: + type: bool + description: Abort if this evaluates to `false` + +optargs: + message: + type: str + description: The error message to print. |