-
-
Notifications
You must be signed in to change notification settings - Fork 113
Update addons command to include 'app' aliases #630
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
Conversation
📝 WalkthroughWalkthroughUpdated the addons command to use "apps" terminology instead of "addons" throughout its description and added "app" and "apps" to the command aliases. Changes are limited to documentation and alias configuration without functional modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
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: 1
🤖 Fix all issues with AI agents
In `@cmd/addons.go`:
- Around line 14-18: The help text mixes "apps" and "addons" which is
inconsistent; update the Short and Long description in cmd/addons.go and the
examples that follow to consistently use the "add-ons" terminology (or
consistently "addons"/"add-ons" spelling) so they match the command name
`addons`, e.g., change occurrences of "apps" to "add-ons" and update example
usage strings (the example lines following the Long text) to show `ha addons
...`; ensure the sentence in Long references the same term ("The addons command
allows you to manage Home Assistant add-ons") and keep grammar (install, remove,
configure and control) consistent.
| Short: "Install, update, remove and configure Home Assistant apps", | ||
| Long: ` | ||
| The addons command allows you to manage Home Assistant add-ons by exposing | ||
| The addons command allows you to manage Home Assistant apps by exposing | ||
| commands for installing, removing, configure and control them. It also provides | ||
| information commands for add-ons.`, | ||
| information commands for apps.`, |
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.
Inconsistent terminology between help text and command usage.
The help text now refers to "apps" throughout, but the examples (lines 20-22) still demonstrate ha addons command usage. This creates confusion for users who read about "apps" but must type "addons".
Additionally, line 16 states "The addons command allows you to manage Home Assistant apps," mixing both terminologies in a single sentence.
Consider one of the following approaches:
- Option 1: Update the examples to use the new
apporappsaliases (e.g.,ha apps logs core_ssh) - Option 2: Keep the original "add-ons" terminology in descriptions and maintain consistency with the command name
📝 Option 1: Update to consistently use "apps" terminology
Long: `
-The addons command allows you to manage Home Assistant apps by exposing
+The apps command allows you to manage Home Assistant apps by exposing
commands for installing, removing, configure and control them. It also provides
information commands for apps.`,
Example: `
- ha addons logs core_ssh
- ha addons install core_ssh
- ha addons start core_ssh`,
+ ha apps logs core_ssh
+ ha apps install core_ssh
+ ha apps start core_ssh`,Option 2: Revert to consistent "add-ons" terminology (if "apps" transition isn't complete):
- Short: "Install, update, remove and configure Home Assistant apps",
+ Short: "Install, update, remove and configure Home Assistant add-ons",
Long: `
-The addons command allows you to manage Home Assistant apps by exposing
+The addons command allows you to manage Home Assistant add-ons by exposing
commands for installing, removing, configure and control them. It also provides
-information commands for apps.`,
+information commands for add-ons.`,📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Short: "Install, update, remove and configure Home Assistant apps", | |
| Long: ` | |
| The addons command allows you to manage Home Assistant add-ons by exposing | |
| The addons command allows you to manage Home Assistant apps by exposing | |
| commands for installing, removing, configure and control them. It also provides | |
| information commands for add-ons.`, | |
| information commands for apps.`, | |
| Short: "Install, update, remove and configure Home Assistant add-ons", | |
| Long: ` | |
| The addons command allows you to manage Home Assistant add-ons by exposing | |
| commands for installing, removing, configure and control them. It also provides | |
| information commands for add-ons.`, |
🤖 Prompt for AI Agents
In `@cmd/addons.go` around lines 14 - 18, The help text mixes "apps" and "addons"
which is inconsistent; update the Short and Long description in cmd/addons.go
and the examples that follow to consistently use the "add-ons" terminology (or
consistently "addons"/"add-ons" spelling) so they match the command name
`addons`, e.g., change occurrences of "apps" to "add-ons" and update example
usage strings (the example lines following the Long text) to show `ha addons
...`; ensure the sentence in Long references the same term ("The addons command
allows you to manage Home Assistant add-ons") and keep grammar (install, remove,
configure and control) consistent.
sairon
left a comment
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.
This is already handled more extensively by #627.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.