Skip to content

Update cover.markdown #38889

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 3 commits into from
May 6, 2025
Merged

Update cover.markdown #38889

merged 3 commits into from
May 6, 2025

Conversation

mithomas
Copy link
Contributor

@mithomas mithomas commented May 5, 2025

Proposed change

Added mention of roller shutters which are listed in to intro text, but missing from the actually relevant device class (see #37704).

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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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
    • Clarified and expanded the description of the "shutter" device class for covers, now explicitly including roller shutters that can be raised or lowered, in addition to swinging and tilting shutters.

Added mention of [roller shutters](https://en.wikipedia.org/wiki/Roller_shutter) which are listed in to intro text, but missing from the actually relevant device class (see home-assistant#37704).
@mithomas mithomas requested a review from a team as a code owner May 5, 2025 19:43
@home-assistant home-assistant bot added the current This PR goes into the current branch label May 5, 2025
Copy link

netlify bot commented May 5, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 13604be
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6819a6649f367c0008f67c00
😎 Deploy Preview https://deploy-preview-38889--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 May 5, 2025

📝 Walkthrough

"""

Walkthrough

The description for the "shutter" device class in the cover integration documentation was expanded to clarify that shutters can also be raised or lowered, explicitly including roller shutters, in addition to the previously described swinging and tilting types.

Changes

File(s) Change Summary
source/_integrations/cover.markdown Expanded and clarified the description of the "shutter" device class to include roller shutters.

Sequence Diagram(s)

No sequence diagram generated, as the change is limited to documentation updates.
"""


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0a7ef1b and 13604be.

📒 Files selected for processing (1)
  • source/_integrations/cover.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/cover.markdown
⏰ 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

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/cover.markdown (1)

61-61: Fix verb form for clarity.

The phrase "to covering an opening" is grammatically incorrect and should read "to cover an opening".
Apply this diff:

- **shutter**: Control of shutters, which are linked slats that can be raised or lowered to cover an opening, such as window or door roller shutters, or that swing out/in to covering an opening or may be tilted for partial cover, such as indoor or exterior window shutters.
+ **shutter**: Control of shutters, which are linked slats that can be raised or lowered to cover an opening, such as window or door roller shutters, or that swing out/in to cover an opening or may be tilted for partial cover, such as indoor or exterior window shutters.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~61-~61: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...oller shutters, or that swing out/in to covering an opening or may be tilted for partial...

(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c42a963 and 51229da.

📒 Files selected for processing (1)
  • source/_integrations/cover.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/cover.markdown

[uncategorized] ~61-~61: This verb may not be in the correct form. Consider using a different form for this context.
Context: ...oller shutters, or that swing out/in to covering an opening or may be tilted for partial...

(AI_EN_LECTOR_REPLACEMENT_VERB_FORM)

Fix incorrect wording.
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, @mithomas 👍

@c0ffeeca7 c0ffeeca7 merged commit 33cd8c6 into home-assistant:current May 6, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants