Add support for custom alarm panel names in Ness Alarm #38625
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough""" WalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Configuration
participant ness_alarm Integration
User ->> Configuration: Adds 'ness_alarm' section with optional 'name'
Configuration ->> ness_alarm Integration: Loads configuration (with or without 'name')
ness_alarm Integration ->> ness_alarm Integration: Sets entity name (user value or default)
""" 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (2)
source/_integrations/ness_alarm.markdown (2)
65-69: Fix trailing whitespace and default value formatting.
Line 65 has a trailing space flagged by markdownlint (MD009), and the default on line 69 includes a leading space inside the quotes, which will surface an unintended leading space in the UI. Please apply:- name: + name: ... - default: " Alarm Panel" + default: "Alarm Panel"🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
66-67: Optional: streamline thenamedescription.
To align with the concise style of other entries, consider rewording:- description: This will be used as the name of the alarm control panel entity. + description: Name of the alarm control panel entity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/ness_alarm.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/ness_alarm.markdown
65-65: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🔇 Additional comments (1)
source/_integrations/ness_alarm.markdown (1)
41-41: Approved insertion of the optionalnameparameter in the example configuration.
The example now clearly shows how users can override the alarm panel’s default name.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/ness_alarm.markdown (1)
65-65: Remove trailing whitespace.There is an extra space after the colon on this line, which violates Markdown lint rules (MD009). Please remove the trailing space.
- name: + name:🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/ness_alarm.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/ness_alarm.markdown
65-65: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
🔇 Additional comments (2)
source/_integrations/ness_alarm.markdown (2)
41-41: New example configuration parameter is documented correctly.The example YAML now includes the optional
namefield with a valid example:"Garage Alarm Panel". This aligns with the new feature description.
65-69: Configuration schema updated for the optionalnameparameter.The schema now declares
nameas an optional string with a default of"Alarm Panel". Please verify that this default matches the implementation in theness_alarmintegration code to prevent any mismatches between documentation and code.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
65-65: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
ness_alarmintegration to include a new optionalnameparameter for specifying the name of the alarm control panel entity.nameoption.