Skip to content

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

Merged
merged 1 commit into from
Apr 30, 2025
Merged

Add docs for Whirlpool binary sensor #38824

merged 1 commit into from
Apr 30, 2025

Conversation

abmantis
Copy link
Member

@abmantis abmantis commented Apr 30, 2025

Proposed change

SSIA.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Updated Whirlpool integration documentation to include support for the binary sensor platform, detailing its ability to report the washer or dryer door state (open or closed).

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 30, 2025
Copy link

netlify bot commented Apr 30, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d6ab42f
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/681227d742acdf0008b1fca5
😎 Deploy Preview https://deploy-preview-38824--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Apr 30, 2025

📝 Walkthrough

Walkthrough

The documentation for the Whirlpool integration was updated to reflect support for the binary_sensor platform. This update includes adding binary_sensor to the list of supported platforms and introducing a new section that describes its functionality, specifically monitoring the washer or dryer door state. No changes were made to the existing descriptions of other platforms.

Changes

File(s) Change Summary
source/_integrations/whirlpool.markdown Added binary_sensor to supported platforms and documented its purpose regarding door state.

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)
Loading

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

📥 Commits

Reviewing files that changed from the base of the PR and between 6d615c7 and d6ab42f.

📒 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 metadata

The ha_platforms list correctly reflects the new binary_sensor platform. Ensure that the corresponding core integration’s manifest.json and code (see core PR #143947) include and register this platform so the docs match the implementation.


59-63: Approve added Binary Sensor section

The 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

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.

Suggested change
- [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)

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 30, 2025
@frenck frenck merged commit 553ed1a into next Apr 30, 2025
9 checks passed
@frenck frenck deleted the whirlpool_door_binary branch April 30, 2025 18:31
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Apr 30, 2025
@github-actions github-actions bot locked and limited conversation to collaborators May 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants