Update docs for home-assistant/core#123427 #34220
Conversation
home-assistant
bot
added
has-parent
📝 Walkthrough📝 WalkthroughWalkthroughThe documentation for the Home Assistant Script Syntax has been revised to enhance clarity and detail. Key updates include explanations of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant System
participant Trigger
User->>System: Initiate wait_template
System-->>User: wait.completed available
User->>Trigger: Trigger event
Trigger-->>System: Trigger event received
System-->>User: wait.trigger available
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 (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
source/_docs/scripts.markdown (1)
284-286: Consider adding a practical example of wait.completed usage.While the documentation is clear, adding a practical example showing how to use
wait.completedwithwait_for_triggerwould help users better understand the feature. For example:# Example: Using wait.completed with wait_for_trigger - wait_for_trigger: - trigger: state entity_id: binary_sensor.motion to: "on" timeout: 00:01:00 - if: - condition: template value_template: "{{ wait.completed }}" then: - service: notify.notify data: message: "Motion detected within timeout" else: - service: notify.notify data: message: "No motion detected within timeout"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- source/_docs/scripts.markdown (1 hunks)
🧰 Additional context used
🔇 Additional comments (2)
source/_docs/scripts.markdown (2)
284-286: LGTM! Clear documentation of wait variable attributes.The documentation clearly explains the new
wait.completedsupport and maintains good organization with alphabetically ordered attributes.
284-286: Documentation aligns perfectly with PR objectives.The changes successfully document the
wait.completedsupport forwait_for_triggerwhile maintaining the desired alphabetical ordering of attributes.
home-assistant
bot
removed
the
parent-merged
Proposed change
home-assistant/core#123427 extends support for
wait.completedtowait_for_trigger(rather than justwait_template)This updates the docs to reflect that, and orders the attributes so that the always present ones are first in the list.
(which also happens to be alphabetical)
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
completedto the wait variable when using triggers (wait_for_trigger) core#123427Checklist
currentbranch.nextbranch.Summary by CodeRabbit
waitandwait_for_triggeractions, including explanations ofwait.completedandwait.trigger.timeoutfeature forwait_templateandwait_for_trigger, with updated examples.repeatactions, including new examples and the introduction of therepeatloop variable.if-thenandchooseactions with comprehensive examples.