-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
[mitsubishi] Document fahrenheit_compatibility
#5809
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
base: current
Are you sure you want to change the base?
Conversation
WalkthroughDocumentation update for the Mitsubishi climate_ir component. Added description of a new optional Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Suggested labels
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this 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)
content/components/climate/climate_ir.md (2)
217-217: Fix formatting: double space before "Defaults".Line 217 has two consecutive spaces before "Defaults to
false."-- **fahrenheit_compatibility** (*Optional*, boolean): Enable this setting if Home Assistant is displaying temperatures in Fahrenheit, so that temperatures set through Home Assistant are sent to the unit the same way as temperatures set on the handheld IR remote. Defaults to `false`. +- **fahrenheit_compatibility** (*Optional*, boolean): Enable this setting if Home Assistant is displaying temperatures in Fahrenheit, so that temperatures set through Home Assistant are sent to the unit the same way as temperatures set on the handheld IR remote. Defaults to `false`.
217-217: Consider aligning naming with similar options in other platforms for consistency.Other platforms use
use_fahrenheit(e.g.,daikin_brcat line 107,midea_irat line 183,whynterat line 297), while this usesfahrenheit_compatibility. The naming difference may be intentional given the distinct behavior (Home Assistant display synchronization vs. unit display), but verify against the corresponding code PR that this naming choice aligns with implementation expectations.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
content/components/climate/climate_ir.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**
⚙️ CodeRabbit configuration file
- Do not generate or add any sequence diagrams
Files:
content/components/climate/climate_ir.md
⏰ 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). (1)
- GitHub Check: Build
🔇 Additional comments (1)
content/components/climate/climate_ir.md (1)
217-217: Documentation placement and format are correct.The new option is properly placed in the Mitsubishi section, follows the established documentation format, and the description clearly explains the purpose and default behavior.
pending acceptance of the esphome code change
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/_index.mdwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
component_namewith your component name in lower_case format with underscores (e.g.,bme280,sht3x,dallas_temp):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
/static/images/folder of this repository.Use the image in your component's index table entry in
/components/_index.md.Example: For a component called "DHT22 Temperature Sensor", use: