Skip to content

Update vesync.markdown #38830

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
May 5, 2025
Merged

Update vesync.markdown #38830

merged 1 commit into from
May 5, 2025

Conversation

cdnninja
Copy link
Contributor

@cdnninja cdnninja commented May 1, 2025

Proposed change

Updating for new feature:
home-assistant/core#137493

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 the VeSync integration documentation to include a new "Switch" category for the device display attribute, indicating whether the display is on or off, across relevant device sections.

@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 May 1, 2025
@cdnninja cdnninja mentioned this pull request May 1, 2025
8 tasks
Copy link

netlify bot commented May 1, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 3c42a69
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6812bfe1b15a5d0008612780
😎 Deploy Preview https://deploy-preview-38830--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.

@cdnninja
Copy link
Contributor Author

cdnninja commented May 1, 2025

@c0ffeeca7 tagging you for the milestone to be re-added here.

Copy link
Contributor

coderabbitai bot commented May 1, 2025

📝 Walkthrough

Walkthrough

The documentation for the VeSync integration was updated to include a new "Switch" category with a display attribute, indicating whether the device display is on or off. This addition was made in multiple sections, specifically for air purifiers, humidifiers, and general device attribute tables. The new attribute is described and illustrated with an example value. No changes were made to code, functionality, or public APIs.

Changes

File Change Summary
source/_integrations/vesync.markdown Added documentation for a new "Switch" category with a display attribute in several sections.

Sequence Diagram(s)

No sequence diagram is 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.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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

🧹 Nitpick comments (1)
source/_integrations/vesync.markdown (1)

164-165: Remove extra blank line
There are two consecutive blank lines before the ## Binary Sensors heading, which violates MD012 (no-multiple-blanks). Please collapse to a single blank line.

Apply this diff:

@@ -164,3 +164,2
- 
- 
## Binary Sensors
+ 
## Binary Sensors
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

165-165: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 59a34bd and 3c42a69.

📒 Files selected for processing (1)
  • source/_integrations/vesync.markdown (2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/vesync.markdown

165-165: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ 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/vesync.markdown (2)

123-126: Addition of display switch under Fan & air quality sensors
The new Switch table entry for display clearly documents the on/off state of the device display. It aligns with the feature introduced in the core integration and follows the existing table structure.


161-164: Addition of display switch under Humidifier section
Mirroring the same Switch entry for humidifiers ensures consistency across device types. This accurately reflects the new display control capability.

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, @cdnninja 👍

@c0ffeeca7 c0ffeeca7 added the parent-merged The parent PR has been merged already label May 5, 2025
@c0ffeeca7 c0ffeeca7 added this to the 2025.5 milestone May 5, 2025
@c0ffeeca7
Copy link
Contributor

@c0ffeeca7 tagging you for the milestone to be re-added here.

thank you for the hint. Normally, the bot would pick up parent-merged

@c0ffeeca7 c0ffeeca7 merged commit 916e4d4 into home-assistant:next May 5, 2025
7 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label May 5, 2025
@github-actions github-actions bot locked and limited conversation to collaborators May 6, 2025
@frenck frenck added the cherry-picked This PR has been manually picked and merged into the current branch label May 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cherry-picked This PR has been manually picked and merged into the current branch 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