summaryrefslogtreecommitdiff
path: root/docs/yaml/functions/set_variable.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'docs/yaml/functions/set_variable.yaml')
-rw-r--r--docs/yaml/functions/set_variable.yaml16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/yaml/functions/set_variable.yaml b/docs/yaml/functions/set_variable.yaml
new file mode 100644
index 000000000..19dc2e165
--- /dev/null
+++ b/docs/yaml/functions/set_variable.yaml
@@ -0,0 +1,16 @@
+name: set_variable
+returns: void
+description: |
+ Assigns a value to the given variable name. Calling
+ `set_variable('foo', bar)` is equivalent to `foo = bar`.
+
+ *(since 0.46.1)* The `value` parameter can be an array type.
+
+posargs:
+ variable_name:
+ type: str
+ description: The name of the variable to set
+
+ value:
+ type: any
+ description: The value to set the variable to