diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/feature_enable_auto_if.md | 4 | ||||
| -rw-r--r-- | docs/yaml/objects/feature.yaml | 17 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/markdown/snippets/feature_enable_auto_if.md b/docs/markdown/snippets/feature_enable_auto_if.md new file mode 100644 index 0000000..5461004 --- /dev/null +++ b/docs/markdown/snippets/feature_enable_auto_if.md @@ -0,0 +1,4 @@ +## Feature objects now have an enable_auto_if method + +This performs the opposite task of the disable_auto_if method, enabling the +feature if the condition is true. diff --git a/docs/yaml/objects/feature.yaml b/docs/yaml/objects/feature.yaml index b6a754b..01209eb 100644 --- a/docs/yaml/objects/feature.yaml +++ b/docs/yaml/objects/feature.yaml @@ -38,6 +38,23 @@ methods: type: bool description: See the table above +- name: enable_auto_if + since: 1.1.0 + returns: feature + description: | + Returns the feature, with `'auto'` converted to `'enabled'` if value is true. + + | Feature / Condition | `value = true` | `value = false` | + | ------------------- | -------------- | --------------- | + | Enabled | Enabled | Enabled | + | Disabled | Disabled | Disabled | + | Auto | Enabled | Auto | + + posargs: + value: + type: bool + description: See the table above + - name: require returns: feature since: 0.59.0 |