Document data updates for SMLIGHT #38412
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThis pull request updates the documentation for the SMLIGHT integration. The modifications clarify that sensor updates will be polled every 5 minutes, with the internet connectivity sensor checked every 15 minutes. It also notes that firmware updates for both core and Zigbee occur once per day. Additionally, the documentation specifies that switches will update in real time if settings are changed via the SLZB device web interface. There are no changes made to the exported or public entities. Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🪧 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 (1)
source/_integrations/smlight.markdown (1)
54-55: Clarify polling intervals and firmware update frequency documentation.
The added documentation specifying that sensor updates occur every 5 minutes—with the internet connectivity sensor checked every 15 minutes—and firmware updates are checked once per day is clear. However, consider rephrasing “with the exception of” to “except for” (or “excepting”) for improved readability as suggested by style guidelines.🧰 Tools
🪛 LanguageTool
[style] ~54-~54: Consider using “except” or “except for”
Context: ... %} for sensor updates every 5 minutes, with the exception of the internet connectivity sensor which ...(WITH_THE_EXCEPTION_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/smlight.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/smlight.markdown
[style] ~54-~54: Consider using “except” or “except for”
Context: ... %} for sensor updates every 5 minutes, with the exception of the internet connectivity sensor which ...
(WITH_THE_EXCEPTION_OF)
🔇 Additional comments (1)
source/_integrations/smlight.markdown (1)
92-93: Real-time switch update description is clear.
The note that switches update in real time when settings are changed via the SLZB device web interface is precise and aligns with the intended functionality of the integration.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
|
Thanks for the reviews! |
* Document data updates for SMLIGHT * small update per coderabbit nit * Update source/_integrations/smlight.markdown Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> * Move data updates to own section --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Proposed change
Add information on data update periods as required for quality scale rule:
https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-data-update
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit