Add description for installation parameters for APCUPSD #38763
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the APC UPS Daemon (apcupsd) integration in Home Assistant was updated to provide clearer guidance on configuring network connections. The changes clarify that both the Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates. 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:
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: 1
🧹 Nitpick comments (1)
source/_integrations/apcupsd.markdown (1)
34-36: Consolidate and clarify NISIP/NISPORT instructions
To improve readability and clarity, consider merging the bullets and embedding default values inline.@@ -33,4 +33,3 @@ - - Look for the lines: `NISIP 0.0.0.0` and `NISPORT 3551`. - - This setting allows it to accept connections on all network interfaces on port 3551. - - If you prefer, you can set this to a specific IP address and port that Home Assistant can reach. + - Ensure `NISIP` is set to `0.0.0.0` (default; listens on all interfaces) or the specific IP Home Assistant will use. + - Ensure `NISPORT` is set to `3551` (default port) or the specific port Home Assistant will use.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/apcupsd.markdown(1 hunks)
⏰ 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
| {% configuration_basic %} | ||
| Host: | ||
| description: "The IP address of the APC UPS Daemon configured above." | ||
| Port: | ||
| description: "The port of the APC UPS Daemon configured above." | ||
| {% endconfiguration_basic %} |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Align configuration keys with schema and include defaults
YAML keys are case-sensitive—use lowercase to match the integration schema. Also, add default values in the descriptions for clarity.
@@ -42,6 +42,9 @@
{% configuration_basic %}
-Host:
- description: "The IP address of the APC UPS Daemon configured above."
-Port:
- description: "The port of the APC UPS Daemon configured above."
+host:
+ description: "The IP address of the APC UPS Daemon (default: 0.0.0.0)."
+port:
+ description: "The port of the APC UPS Daemon (default: 3551)."
+{% endconfiguration_basic %}Committable suggestion skipped: line range outside the PR's diff.
Proposed change
This PR adds description for installation parameters for APCUPSD per https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/docs-installation-parameters.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.