Remove mentions of timer finished event possibly firing on startup #36423
Conversation
This documentation seems to be here from old intended behavior, but is not current behavior.
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Home Assistant Changes
Sequence DiagramsequenceDiagram
participant HA as Home Assistant
participant Timer as Timer Integration
HA->>Timer: Start/Restore Timer
alt Timer Restored
Timer-->>HA: Restore Timer State
else Timer Completed
Timer->>HA: Fire timer.finished Event
HA->>HA: Process Event
end
The sequence diagram illustrates the simplified timer restoration and event handling process, showing how timers are managed during Home Assistant startup without explicitly firing events for timers that would have expired while the system was stopped. 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 (
|
![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
🧹 Nitpick comments (1)
source/_integrations/timer.markdown (1)
80-80: Consider clarifying the finished_at timing description.While the removal of startup-related content is correct, the description of
finished_attiming could be more precise.Consider this minor refinement:
-| `timer.finished` | Fired when a timer has completed and includes `finished_at` date/time in event data. `finished_at` should usually be now, or within the last several seconds. | +| `timer.finished` | Fired when a timer has completed and includes `finished_at` date/time in event data. The `finished_at` value represents the completion time and typically matches the current time or is within the last few seconds. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/timer.markdown(3 hunks)
🔇 Additional comments (2)
source/_integrations/timer.markdown (2)
20-20: LGTM! Clear and accurate clarification.
The added note effectively clarifies the behavior of the timer.finished event during startup, which aligns with the current implementation.
59-59: LGTM! Simplified and accurate description.
The updated description correctly focuses on the core functionality of the restore option without referencing the removed startup event behavior.
This documentation seems to be here from old intended behavior, but is not current behavior.
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
timer.finishedevent in the timer integration documentation.restoreoption to simplify explanations regarding timer restoration on startup.