Improve wording in the NetBird client app #4316
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR improves the wording and consistency of command descriptions in the NetBird client application by updating the Short and Long descriptions for various CLI commands.
- Standardizes capitalization patterns in command descriptions (e.g., "Print" instead of "prints")
- Adds detailed
Longdescriptions to several commands for better user guidance - Improves clarity and consistency in command help text across the client interface
Reviewed Changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| client/cmd/version.go | Updates version command description with more descriptive text |
| client/cmd/up.go | Adds comprehensive description for network connection command |
| client/cmd/status.go | Improves status command description and adds detailed Long text |
| client/cmd/ssh.go | Capitalizes SSH command description |
| client/cmd/service_installer.go | Capitalizes install command description |
| client/cmd/service.go | Improves service management command description |
| client/cmd/profile.go | Updates profile management commands with better descriptions |
| client/cmd/networks.go | Clarifies networks command description |
| client/cmd/logout.go | Improves deregister command description and adds warning |
| client/cmd/login.go | Simplifies and clarifies login command description |
| client/cmd/down.go | Improves disconnect command description with details |
| client/cmd/debug.go | Simplifies debug command description |
| Short: "remove a profile", | ||
| Long: `Remove a profile from the NetBird client. The profile must not be active.`, | ||
| Short: "Remove a profile", | ||
| Long: `Remove a profile from the NetBird client. The profile must not be inactive.`, |
There was a problem hiding this comment.
The logic is incorrect. The Long description says 'The profile must not be inactive' but this should likely be 'The profile must not be active' or 'The profile must be inactive', as you typically cannot remove an active profile.
Suggested change
| Long: `Remove a profile from the NetBird client. The profile must not be inactive.`, | |
| Long: `Remove a profile from the NetBird client. The profile must not be active.`, |
Copilot uses AI. Check for mistakes.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
Issue ticket number and link
Stack
Checklist
Documentation
Select exactly one:
No new commands added.
Docs PR URL (required if "docs added" is checked)
Paste the PR link from https://github.com/netbirdio/docs here:
https://github.com/netbirdio/docs/pull/__