-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Add docs for Whirlpool binary sensor #38824
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
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 Whirlpool integration was updated to reflect support for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Whirlpool Integration Documentation
User->>Whirlpool Integration Documentation: View supported platforms
Whirlpool Integration Documentation-->>User: Show Climate, Sensor, Binary Sensor platforms
User->>Whirlpool Integration Documentation: Read about Binary Sensor
Whirlpool Integration Documentation-->>User: Explain door state monitoring (open/closed)
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/whirlpool.markdown
(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/whirlpool.markdown
55-55: Link fragments should be valid
null
(MD051, link-fragments)
⏰ 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
🔇 Additional comments (2)
source/_integrations/whirlpool.markdown (2)
15-15
: Include binary_sensor in supported platforms metadataThe
ha_platforms
list correctly reflects the newbinary_sensor
platform. Ensure that the corresponding core integration’smanifest.json
and code (see core PR #143947) include and register this platform so the docs match the implementation.
59-63
: Approve added Binary Sensor sectionThe new section clearly explains the sensor’s purpose and matches the style of other platform sections. Consider adding a usage example or sample entity IDs later to enhance user guidance.
@@ -51,9 +52,16 @@ Dryers: | |||
|
|||
This {% term integration %} maps appliances to entities in Home Assistant. A single appliance may be represented by one or more entities. | |||
|
|||
- [Binary Sensor](#binary_sensor) |
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.
Fix link fragment for Binary Sensor
The bullet uses an underscore in the fragment (#binary_sensor
), but the header slug will be #binary-sensor
. Update the link to ensure it correctly navigates to the section:
- - [Binary Sensor](#binary_sensor)
+ - [Binary Sensor](#binary-sensor)
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
- [Binary Sensor](#binary_sensor) | |
- [Binary Sensor](#binary-sensor) |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
55-55: Link fragments should be valid
null
(MD051, link-fragments)
Proposed change
SSIA.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit