Skip to content
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

Add scene support to WMS WebControl pro #34887

Merged
merged 3 commits into from
Oct 11, 2024

Conversation

mback2k
Copy link
Contributor

@mback2k mback2k commented Sep 23, 2024

Proposed change

Add scene support to WMS WebControl pro

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

  • New Features

    • Added support for "scenes" as a platform alongside "covers."
    • Introduced a new section titled "Scenes" detailing activation capabilities.
  • Documentation

    • Expanded support information to reference both "covers" and "scenes."
    • Updated formatting of the ha_release field for consistency.

@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 Sep 23, 2024
Copy link

netlify bot commented Sep 23, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 3455c48
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6707df1ff0ba3e000887128a
😎 Deploy Preview https://deploy-preview-34887--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.

@mback2k mback2k marked this pull request as ready for review September 23, 2024 20:41
Copy link
Contributor

coderabbitai bot commented Sep 23, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces several modifications to the source/_integrations/wmspro.markdown document. Key changes include a shift in the quotation style for the ha_release field, the addition of "scene" to the ha_platforms section, an expanded description in the support information section to include both "covers" and "scenes," and the introduction of a new section titled "Scenes" that outlines the activation capabilities of scenes.

Changes

File Change Summary
source/_integrations/wmspro.markdown - ha_release field changed from double quotes to single quotes.
- ha_platforms updated to include "scene."
- Support information now references both "covers" and "scenes."
- New section titled "Scenes" added, indicating scenes can be activated but not changed or monitored.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ff66a0f and e3c1e9b.

📒 Files selected for processing (1)
  • source/_integrations/wmspro.markdown (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/wmspro.markdown

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?

❤️ 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 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: 0

Outside diff range and nitpick comments (1)
source/_integrations/wmspro.markdown (1)

39-40: LGTM with minor formatting suggestions

The new "Scenes" section provides clear and concise information about the capabilities of scenes in this integration. However, there are a couple of minor formatting issues to address:

  1. Add a blank line before and after the "Scenes" header.
  2. Add a blank line before and after the list item.

Here's the suggested formatting:

## Covers

- *Patio awnings* can be opened, closed, set to a certain position and their movement stopped.
- The integration and library *may* already support other types of awnings with a single motor.

## Scenes

- Scenes can be activated, but not changed or monitored.
Tools
LanguageTool

[duplication] ~39-~39: Possible typo: you repeated a word
Context: ...pes of awnings with a single motor. ## Scenes - Scenes can be activated, but not changed or mo...

(ENGLISH_WORD_REPEAT_RULE)

Markdownlint

39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


40-40: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5707b93 and ff66a0f.

<details>
Files selected for processing (1)
  • source/_integrations/wmspro.markdown (3 hunks)
Additional context used
LanguageTool
source/_integrations/wmspro.markdown

[duplication] ~39-~39: Possible typo: you repeated a word
Context: ...pes of awnings with a single motor. ## Scenes - Scenes can be activated, but not changed or mo...

(ENGLISH_WORD_REPEAT_RULE)

Markdownlint
source/_integrations/wmspro.markdown

39-39: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines

(MD022, blanks-around-headings)


40-40: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

Additional comments not posted (4)
source/_integrations/wmspro.markdown (4)

7-7: LGTM: Consistent quote style

The change from double quotes to single quotes for the ha_release field aligns with the typical YAML style used in Home Assistant documentation.


28-28: LGTM: Updated support information

The support information has been correctly updated to include both covers and scenes, providing clear navigation to the relevant sections of the document.


Line range hint 7-40: Overall: Excellent addition of scene support documentation

This PR successfully adds scene support documentation to the WMS WebControl pro integration. The changes are well-documented, clear, and consistent with the PR objectives. Here's a summary of the key updates:

  1. Added 'scene' to the ha_platforms list.
  2. Updated the support information to include scenes.
  3. Added a new "Scenes" section describing the capabilities.

These changes effectively communicate the new scene support feature to users of the integration. The minor formatting suggestions I've provided will further improve the document's readability and consistency with Home Assistant's documentation standards.

Great work on enhancing the WMS WebControl pro integration documentation!


15-15: LGTM: Scene platform added

The addition of 'scene' to the ha_platforms list correctly reflects the new scene support for this integration.

Let's verify that this change is consistent with other parts of the document:

Verification successful

Verification Passed: Scene platform addition is consistent

The addition of 'scene' to the ha_platforms list aligns with other mentions in the document, confirming consistency with the Scenes section.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for mentions of 'scene' or 'scenes' in the file

rg -i 'scene' source/_integrations/wmspro.markdown

Length of output: 212

c0ffeeca7
c0ffeeca7 previously approved these changes Sep 26, 2024
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @mback2k 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Sep 26, 2024
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Oct 10, 2024
Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

There's a merge conflict

@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft October 10, 2024 13:44
@joostlek joostlek removed the awaits-parent Awaits the merge of an parent PR label Oct 10, 2024
@mback2k
Copy link
Contributor Author

mback2k commented Oct 10, 2024

There's a merge conflict

Rebased and solved.

@mback2k mback2k marked this pull request as ready for review October 10, 2024 14:11
@c0ffeeca7 c0ffeeca7 dismissed joostlek’s stale review October 11, 2024 05:29

merge conflict has been resolved

@c0ffeeca7 c0ffeeca7 merged commit a6c30f2 into home-assistant:next Oct 11, 2024
7 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Oct 11, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 12, 2024
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.

3 participants