8000 Fix mqtt fan speed range min and max config descriptions by jbouwh · Pull Request #39183 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Fix mqtt fan speed range min and max config descriptions #39183

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 1 commit into from
May 25, 2025
Merged

Fix mqtt fan speed range min and max config descriptions #39183

merged 1 commit into from
May 25, 2025

Conversation

jbouwh
Copy link
Contributor
@jbouwh jbouwh commented May 23, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Fix mqtt fan speed range min and max config descriptions.

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 explanation for how the percentage_step is calculated for speed_range_max and speed_range_min options. No changes to functionality.

@home-assistant home-assistant bot added the current This PR goes into the current branch label May 23, 2025
@netlify Netlify
Copy link
netlify bot commented May 23, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 4020928
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6830bab78c5ea10008929ea5
😎 Deploy Preview https://deploy-preview-39183--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.

@jbouwh jbouwh mentioned this pull request May 23, 2025
Merged
19 tasks
@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels May 23, 2025
@jbouwh jbouwh mentioned this pull request May 23, 2025
Merged
19 tasks
@home-assistant home-assistant bot added the has-parent This PR has a parent PR in a other repo label May 23, 2025
@home-assistant home-assistant deleted a comment from home-assistant bot May 23, 2025
@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented May 23, 2025
📝 Walkthrough

Walkthrough

The documentation for the speed_range_max and speed_range_min configuration options in the fan MQTT integration was updated to clarify the calculation method for percentage_step. The text now explicitly states that percentage_step is 100 divided by the number of speeds in the speed range. No code or logic was modified.

Changes

File(s) Change Summary
source/_integrations/fan.mqtt.markdown Updated documentation to clarify how percentage_step is calculated for speed range configuration.

Sequence Diagram(s)

No sequence diagram is generated as the changes are purely documentation updates without any impact on control flow or feature logic.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

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 May 23, 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/fan.mqtt.markdown (2)

296-300: Clarify percentage_step calculation in speed_range_max description.

The updated description defines percentage_step as 100 divided by the number of speeds, but readers may be unclear what “number of speeds” refers to. Consider specifying that it’s the count of discrete settings in the inclusive range (i.e., (speed_range_max - speed_range_min + 1)) to remove any ambiguity.

301-304: Polish formatting and clarity in speed_range_min.

The percentage step explanation is now consistent, but:

  • For consistency with other percentage mentions, remove the space before % (e.g., use 0%).
  • The parenthetical could be tightened for readability. For example:
    “speed_range_min - 1 corresponds to 0% (off not included).”
📜 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 3db7a4a and 4020928.

📒 Files selected for processing (1)
  • source/_integrations/fan.mqtt.markdown (1 hunks)

@jbouwh
Copy link
Contributor Author
jbouwh commented May 23, 2025

Actionable comments posted: 0
🧹 Nitpick comments (2)

source/_integrations/fan.mqtt.markdown (2)> 296-300: Clarify percentage_step calculation in speed_range_max description.

The updated description defines percentage_step as 100 divided by the number of speeds, but readers may be unclear what “number of speeds” refers to. Consider specifying that it’s the count of discrete settings in the inclusive range (i.e., (speed_range_max - speed_range_min + 1)) to remove any ambiguity.

301-304: Polish formatting and clarity in speed_range_min.
The percentage step explanation is now consistent, but:

  • For consistency with other percentage mentions, remove the space before % (e.g., use 0%).
  • The parenthetical could be tightened for readability. For example:
    “speed_range_min - 1 corresponds to 0% (off not included).”

📜 Review details

There is an example to explain this on the existing page

@jbouwh
Copy link
Contributor Author
jbouwh commented May 23, 2025

Actionable comments posted: 0
🧹 Nitpick comments (2)

source/_integrations/fan.mqtt.markdown (2)> 296-300: Clarify percentage_step calculation in speed_range_max description.

The updated description defines percentage_step as 100 divided by the number of speeds, but readers may be unclear what “number of speeds” refers to. Consider specifying that it’s the count of discrete settings in the inclusive range (i.e., (speed_range_max - speed_range_min + 1)) to remove any ambiguity.

301-304: Polish formatting and clarity in speed_range_min.
The percentage step explanation is now consistent, but:

  • For consistency with other percentage mentions, remove the space before % (e.g., use 0%).
  • The parenthetical could be tightened for readability. For example:
    “speed_range_min - 1 corresponds to 0% (off not included).”

📜 Review details

The extra space improves readability IMO

@home-assistant
Copy link

Hey there @emontnemery, @bdraco, mind taking a look at this feedback as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label May 24, 2025
@silamon silamon merged commit 77d8865 into current May 25, 2025
9 checks passed
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels May 25, 2025
@silamon silamon deleted the mqtt-fan-fix-description branch May 25, 2025 16:56
@github-actions github-actions bot locked and limited conversation to collaborators May 26, 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

@NoRi2909 NoRi2909 NoRi2909 approved these changes

Assignees

@bdraco bdraco

@emontnemery emontnemery

Labels
by-code-owner current This PR goes into the current branch has-parent This PR has a parent PR in a other repo integration: mqtt
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jbouwh @silamon @NoRi2909 @bdraco @emontnemery
0