Skip to content

Fixed bad example and missing options for set_swing_mode #39993

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jul 14, 2025
Merged

Fixed bad example and missing options for set_swing_mode #39993

merged 2 commits into from
Jul 14, 2025

Conversation

parautenbach
Copy link
Contributor

@parautenbach parautenbach commented Jul 13, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Fixed bad example and missing options for set_swing_mode.

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 the allowed values for the swing_mode attribute in the climate.set_swing_mode action.
    • Updated example automation to use swing_mode: both for better clarity.

@parautenbach
: off, horizontal, vertical or both
63f3a44 
Bad example and incomplete list of options.
@parautenbach
Merge pull request #1 from parautenbach/parautenbach-climate-docs-swi…
0acfd8f 
…ng-mode-fix

Fixed bad example and missing options for set_swing_mode
@parautenbach parautenbach requested a review from a team as a code owner July 13, 2025 12:38
@home-assistant home-assistant bot added the current This PR goes into the current branch label Jul 13, 2025
@netlify Netlify
Copy link

netlify bot commented Jul 13, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 0acfd8f
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6873a8bfdc2787000821c7b2
😎 Deploy Preview https://deploy-preview-39993--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 project configuration.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 13, 2025

📝 Walkthrough

Walkthrough

The documentation for the climate.set_swing_mode action was updated to clarify the allowed values for the swing_mode attribute, explicitly listing valid options. The example automation was also modified to use a valid value for swing_mode. No code or public API changes were made.

Changes

File Change Summary
source/_integrations/climate.markdown Updated documentation for climate.set_swing_mode to list valid swing_mode values and revised example usage.

Sequence Diagram(s)

No sequence diagram 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

coderabbitai[bot]
coderabbitai bot reviewed Jul 13, 2025
View reviewed changes
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 (2)
source/_integrations/climate.markdown (2)

216-216: Add trailing pipe to appease markdownlint

MD055/table-pipe-style complains because this row has no trailing |. Since you modified it anyway, a one-character patch keeps the linter quiet and aligns with the suggested style:

-| `swing_mode` | no | New value of swing mode: `off`, `horizontal`, `vertical` or `both`.
+| `swing_mode` | no | New value of swing mode: `off`, `horizontal`, `vertical` or `both`. |

239-241: Mirror the allowed-values hint for horizontal swing

For consistency, consider explicitly listing the valid options for swing_horizontal_mode, just as you now do for swing_mode. Keeps the docs self-contained and saves users a trip to dev tools.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between d491adf and 0acfd8f.

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

216-216: Table pipe style
Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe

(MD055, table-pipe-style)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/climate.markdown (1)

226-231: Example now matches the documented options – LGTM

Using swing_mode: both in the sample automation aligns with the newly documented allowed values.

@silamon silamon merged commit 210115f into home-assistant:current Jul 14, 2025
7 checks passed
joostlek pushed a commit to joostlek/home-assistant.io that referenced this pull request Jul 14, 2025
@parautenbach @joostlek
Fixed bad example and missing options for set_swing_mode (home-assist…
f79748d 
…ant#39993)
@github-actions github-actions bot locked and limited conversation to collaborators Jul 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@silamon silamon silamon approved these changes

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@parautenbach @silamon
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy