Document update frequency better for lamarzocco #39333
Conversation
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe documentation for the La Marzocco integration was revised to relocate and expand the explanation of its data update mechanisms. The brief original description was replaced with a dedicated "Data updates" section that provides more detailed polling intervals and clarifies the behavior when push updates are unavailable. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Integration
participant Cloud
User->>Integration: Uses integration
Integration->>Cloud: Receives push updates (general status)
alt If push updates unavailable
Integration->>Cloud: Polls every 15s (machine info)
Integration->>Cloud: Polls every 15m (statistics)
Integration->>Cloud: Polls every 30m (schedules)
Integration->>Cloud: Polls every 8h (firmware updates)
end
Cloud-->>Integration: Sends updated data
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (1)
source/_integrations/lamarzocco.markdown (1)
60-63: Enhance readability and fix punctuation in the new Data updates sectionThere's a missing comma after the introductory conditional clause, and the long inline list of polling intervals would be clearer as a bulleted list. For example:
- By default, this integration will receive push updates from the cloud about its general status. If that is not possible it will query the cloud every 15 seconds for an update of general machine information, every 15 minutes for new statistics, every 30 minutes for updated schedules and every 8 hours for a firmware update. + By default, this integration will receive push updates from the cloud about its general status. If that is not possible, it will query the cloud at the following intervals: + + - Every 15 seconds for general machine information + - Every 15 minutes for new statistics + - Every 30 minutes for updated schedules + - Every 8 hours for a firmware update🧰 Tools
🪛 LanguageTool
[typographical] ~62-~62: Consider adding a comma here.
Context: ...bout its general status. If that is not possible it will query the cloud every 15 second...(IF_THAT_S_NOT_POSSIBLE_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/lamarzocco.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/lamarzocco.markdown
[typographical] ~62-~62: Consider adding a comma here.
Context: ...bout its general status. If that is not possible it will query the cloud every 15 second...
(IF_THAT_S_NOT_POSSIBLE_COMMA)
⏰ 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
|
thanks @thecode! |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit