-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix valve names #36606
Fix valve names #36606
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces modifications to the valve integration documentation in Home Assistant, focusing on renaming action commands to provide more explicit and descriptive names. The changes aim to improve clarity by adding more context to the valve-related commands, specifically updating Changes
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 (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/valve.markdown (1)
Line range hint
69-91
: Consider enhancing position parameter documentation.While the documentation is accurate, consider making the position range more explicit in the parameter description:
| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of valves. Use `entity_id: all` to target all. -| `position` | no | Integer between 0 (fully closed) and 100 (fully open). +| `position` | no | Integer between 0 and 100, where 0 represents fully closed and 100 represents fully open.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/valve.markdown
(3 hunks)
🔇 Additional comments (2)
source/_integrations/valve.markdown (2)
49-50
: LGTM! Command naming improvements enhance clarity.
The renamed commands (valve.open_valve
, valve.close_valve
, valve.set_valve_position
) are more explicit and follow a consistent pattern, which reduces potential ambiguity for users.
64-68
: LGTM! Example correctly demonstrates the new command.
The automation example accurately reflects the renamed command and maintains a clear, simple demonstration.
Proposed change
Apparently the names where wrong. Shout out to @Petro31 and his broken fingers.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
valve.open
→valve.open_valve
valve.close
→valve.close_valve
valve.set_position
→valve.set_valve_position