Plural docs for template entities #35133
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes in this pull request focus on updating the documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User->>Documentation: Review template integration
Documentation->>User: Display updated pluralization and configuration options
User->>Documentation: Understand multiple triggers, conditions, actions
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
source/_integrations/template.markdown (2)
102-104: LGTM: Plural form update and suggested wording improvementThe change to plural form ("triggers") is correct and aligns with the PR objectives. However, consider simplifying the phrase "exactly the same" for improved readability.
Consider revising:
- Triggers follow the same format and work exactly the same as [triggers in automations][trigger-doc]. + Triggers follow the same format and work identically to [triggers in automations][trigger-doc].🧰 Tools
🪛 LanguageTool
[style] ~102-~102: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...riggers follow the same format and work exactly the same as [triggers in automations][trigger-do...(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
[uncategorized] ~104-~104: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...res, all related entities will re-render and it will have access to [the trigger dat...(COMMA_COMPOUND_SENTENCE)
438-439: LGTM: Informative addition with minor style suggestionThe addition of a video tutorial explanation is helpful for users. However, for consistency and proper style, consider a small adjustment.
Consider revising:
- This video tutorial explains how to set up a trigger based template that makes use of an action to retrieve the weather forecast (precipitation). + This video tutorial explains how to set up a trigger-based template that makes use of an action to retrieve the weather forecast (precipitation).🧰 Tools
🪛 LanguageTool
[uncategorized] ~438-~438: This expression is usually spelled with a hyphen.
Context: ...video tutorial explains how to set up a trigger based template that makes use of an action to...(BASED_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- source/_integrations/template.markdown (11 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/template.markdown
[style] ~102-~102: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...riggers follow the same format and work exactly the same as [triggers in automations][trigger-do...(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
[uncategorized] ~104-~104: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...res, all related entities will re-render and it will have access to [the trigger dat...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~438-~438: This expression is usually spelled with a hyphen.
Context: ...video tutorial explains how to set up a trigger based template that makes use of an action to...(BASED_HYPHEN)
🔇 Additional comments (6)
source/_integrations/template.markdown (6)
73-74: LGTM: Improved clarity with plural formsThe change from singular to plural forms ("triggers" instead of "trigger") accurately reflects the updated functionality allowing multiple triggers, conditions, and actions. This aligns well with the PR objectives.
Line range hint
115-123: LGTM: Correct update to plural form in YAML exampleThe YAML example has been correctly updated to use the plural form "triggers" instead of "trigger". This change is consistent with the PR objectives and accurately reflects the new functionality allowing multiple triggers.
130-143: LGTM: Accurate updates to configuration variablesThe configuration variables have been correctly updated to use plural forms ("triggers", "conditions", "actions"). The descriptions have been appropriately modified to reflect the ability to define multiple triggers, conditions, and actions. These changes are consistent with the PR objectives and provide clear guidance for users.
Line range hint
555-568: LGTM: Correct update to plural form in YAML exampleThe YAML example has been correctly updated to use the plural form "triggers" instead of "trigger". This change is consistent with the PR objectives and accurately reflects the new functionality allowing multiple triggers in template entities.
Line range hint
590-614: LGTM: Consistent updates to plural forms in YAML examplesAll YAML examples in these sections have been correctly updated to use the plural form "triggers" instead of "trigger". These changes are consistent across all examples and accurately reflect the new functionality allowing multiple triggers in template entities. The updates align perfectly with the PR objectives.
Also applies to: 806-817, 873-886
Line range hint
1-1069: Overall: Excellent updates to documentationThe changes in this PR successfully update the template integration documentation to support plural forms of triggers, actions, and conditions. All modifications are consistent with the PR objectives and accurately reflect the new functionality. The updates improve clarity and provide users with correct information about the enhanced capabilities of template entities.
A few minor style suggestions were made to further improve readability, but these are not critical. Great job on maintaining consistency throughout the document and providing clear, accurate information for users.
|
There's a merge conflict. |
This is not the merge conflict you're looking for 😁
|
Proposed change
This MR updates the docs for template entities that now understand plural forms (triggers, actions, conditions) used by automations starting with 2024.10. Also here the plural forms will be the default in the internal configuration view, and the old syntax is still fully compatible, and there are probably no plans to remove the legacy singular form, at least not by me 😉
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
templateintegration, emphasizing the ability to define multiple triggers, conditions, and actions.