Improve template trigger/condition descriptions #18504
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed change
Two minor improvements to description rendering in expansion panel header for templates in automations:
The current description for template trigger is "When a template triggers". I think this can be improved, as this is somewhat of a circular definition and is not immediately clear what it means. (When does this trigger execute? When it triggers.).
I propose the more exact description "When a template changes from false to true". I think this will be an improvement as there is sometimes some confusion around this trigger, with some users expecting it to trigger everytime the template evaluates to true.
Condition template currently has no description, and just displays "Template". This looks odd when juxtaposed with the other conditions, most/all of which use an imperitive sentence to describe the condition, such as "Test if... or "Confirm that....".
I have added the sentence "Test if template renders a value equal to true", which matches how this condition is described in the official documentation.
Type of change
Example configuration
Additional information
Checklist
If user exposed functionality or configuration variables are added/changed: