Update hass.markdown #36608
Update hass.markdown #36608
Conversation
add text as per issue home-assistant#20086 (home-assistant#20086). also change bash to text in the markdown to remove the colour highlighting from 'exit', 'file' etc
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Changes
Note: No changes were made to exported or public entities in this update. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (
|
![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
🧹 Nitpick comments (1)
source/_docs/tools/hass.markdown (1)
6-7: Improve text formatting and link accessibilityThe added context is valuable, but there are a few formatting improvements to consider:
-The command-line part of Home Assistant is `hass`.\ -This tool is only available to Home Assistant Core users, is started from the command line on the computer running Home Assistant Core (accessed perhaps via ssh) and is not the same as Home Assistant CLI (aka hass-cli). [link](https://www.home-assistant.io/blog/2019/02/04/introducing-home-assistant-cli/) +The command-line part of Home Assistant is `hass`. + +This tool is only available to Home Assistant Core users, is started from the command line on the computer running Home Assistant Core (accessed perhaps via ssh) and is not the same as [Home Assistant CLI (hass-cli)](https://www.home-assistant.io/blog/2019/02/04/introducing-home-assistant-cli/).Changes:
- Remove the unnecessary backslash
- Add a line break for better readability
- Make the link text more descriptive by incorporating it into the sentence
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_docs/tools/hass.markdown(1 hunks)
🔇 Additional comments (1)
source/_docs/tools/hass.markdown (1)
9-9: LGTM! Good choice on syntax highlighting
The change from bash to text syntax highlighting is a good improvement. It reduces distracting color highlighting for command-line terms while maintaining clear readability of the options and their descriptions.
| @@ -3,10 +3,10 @@ title: "hass" | |||
| description: "Description of hass." | |||
| --- | |||
|
|
|||
| The command-line part of Home Assistant is `hass`. | |||
| The command-line part of Home Assistant is `hass`.\ | |||
| This tool is only available to Home Assistant Core users, is started from the command line on the computer running Home Assistant Core (accessed perhaps via ssh) and is not the same as Home Assistant CLI (aka hass-cli). [link](https://www.home-assistant.io/blog/2019/02/04/introducing-home-assistant-cli/) | |||
There was a problem hiding this comment.
Small wording adjustment.
Removed the reference of hass-cli, which is no longer part of the Home Assistant project and is a third-party tooling.
| This tool is only available to Home Assistant Core users, is started from the command line on the computer running Home Assistant Core (accessed perhaps via ssh) and is not the same as Home Assistant CLI (aka hass-cli). [link](https://www.home-assistant.io/blog/2019/02/04/introducing-home-assistant-cli/) | |
| This tool is only available to users of the Home Assistant Core installation method. It is started from the command line on the computer running Home Assistant Core (accessed perhaps via SSH). |
There was a problem hiding this comment.
In relative authority on what this thing should say, I'm so far down the list so as to not count!
There was a problem hiding this comment.
I do not fully grasp what you mean by that response. That might be a language gap on my end. Could you clarify your wording differently?
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: Franck Nijhof <[email protected]>
add text as per issue #20086 (#20086).
also change bash to text in the markdown to remove the colour highlighting from 'exit', 'file' etc
Proposed change
This is to address the comment in the issue #20086
While here I changed the markdown to remove un-needed, and slightly distracting colour highlighting (change
bash totext)Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
hasscommand-line toolbashtotext