Update unit of measurement in A. O. Smith docs #35091
Conversation
home-assistant
bot
added
Hacktoberfest
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
📝 WalkthroughWalkthroughThe changes in this pull request focus on updating the documentation for the A. O. Smith integration with Home Assistant. Key modifications include a revised description of the hot water availability sensor, which now indicates availability as a percentage. The integration's metadata has been clarified for the 2024.1 release, while maintaining support for various platforms and connection instructions. The list of known compatible models remains unchanged, and users are still encouraged to provide feedback through GitHub. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant AOSmithApp
User->>HomeAssistant: Connect to A. O. Smith integration
HomeAssistant->>AOSmithApp: Request hot water availability
AOSmithApp-->>HomeAssistant: Provide availability as percentage
HomeAssistant-->>User: Display availability percentage
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
source/_integrations/aosmith.markdown (1)
75-75: Approve the change and suggest adding blank lines.The update to report hot water availability as a percentage aligns with the PR objective and improves clarity. However, to address the Markdownlint issue and improve readability, please add blank lines before and after the list of sensor entities.
Apply this diff to surround the list with blank lines:
### Sensor The following sensor entities are available: + - Hot water availability (percentage) - Energy usage + ## Disclaimer🧰 Tools
🪛 Markdownlint
75-75: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- source/_integrations/aosmith.markdown (1 hunks)
🧰 Additional context used
🪛 Markdownlint
source/_integrations/aosmith.markdown
75-75: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
home-assistant
bot
removed
the
needs-rebase
Proposed change
Change the unit of measurement for hot water status to percentage.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit