Add Trigger Selector example in Selectors Documentation #37571
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation update adds a new section under the "Trigger selector" heading. This section explains how to merge custom triggers with the default ones, and it includes an example YAML snippet showcasing the use of the Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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
🧹 Nitpick comments (3)
source/_docs/blueprint/selectors.markdown (3)
1542-1544: Grammatical Correction: Use the Appropriate ArticleThe new text contains “within an blueprint” at line 1543. Since “blueprint” starts with a consonant sound, please change “an blueprint” to “a blueprint”. This improves the grammatical correctness of the documentation.
-If the trigger(s) should exist within an blueprint that already has some default triggers defined, +If the trigger(s) should exist within a blueprint that already has some default triggers defined,🧰 Tools
🪛 LanguageTool
[misspelling] ~1543-~1543: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...s If the trigger(s) should exist within an blueprint that already has some default...(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
1542-1542: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above(MD022, blanks-around-headings)
1542-1542: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
1542-1547: Markdown Formatting: Surround Headings and Fenced Code Blocks with Blank LinesAccording to markdownlint rules (MD022 and MD031), headings and fenced code blocks should be surrounded by blank lines. Please ensure that a blank line is added:
• Before and after the new heading “### Example - Merging with existing triggers” (line 1542), and
• Before the opening and after the closing of the fenced YAML code block (lines 1545 and 1556).For example, you could modify the surrounding content as follows:
-… (previous content) -### Example - Merging with existing triggers + +### Example - Merging with existing triggers +🧰 Tools
🪛 LanguageTool
[misspelling] ~1543-~1543: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...s If the trigger(s) should exist within an blueprint that already has some default...(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
1542-1542: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above(MD022, blanks-around-headings)
1542-1542: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
1545-1545: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
1545-1555: Clarification on YAML Example: Explain the PlaceholderThe fenced YAML snippet uses
[...]as a placeholder for additional trigger configuration on line 1554. It might be unclear to users what specific content should replace this placeholder. Consider adding a brief comment or note clarifying that users should substitute their custom trigger settings in place of[...].For example, you could add:
# Replace [...] with additional trigger configurations as needed.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1545-1545: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_docs/blueprint/selectors.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_docs/blueprint/selectors.markdown
[misspelling] ~1543-~1543: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...s If the trigger(s) should exist within an blueprint that already has some default...
(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
source/_docs/blueprint/selectors.markdown
1542-1542: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
1542-1542: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
1545-1545: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Proposed change
Add an example of how to merge a trigger selector with existing triggers within a blueprint.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.Summary by CodeRabbit