-
Notifications
You must be signed in to change notification settings - Fork 111
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
RSDK-9287: standardize command flags #4669
base: main
Are you sure you want to change the base?
RSDK-9287: standardize command flags #4669
Conversation
@@ -1462,11 +1457,13 @@ var app = &cli.App{ | |||
Usage: "list machines in an organization and location", | |||
Flags: []cli.Flag{ | |||
&cli.StringFlag{ | |||
Name: organizationFlag, | |||
Name: generalFlagOrgID, | |||
Aliases: []string{generalFlagAliasOrgID}, |
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 now makes a help message look like:
rdk % go run ./cli/viam machines list --help
NAME:
viam machines list - list machines in an organization and location
USAGE:
viam machines list [command options] [arguments...]
OPTIONS:
--location-id value, --location value (default: first location alphabetically)
--org-id value, --organization value (default: first organization alphabetically)
This applies to all the org and location changes. In the ticket, it says we should stop advertising the wrong flags (aka aliases). I changed the comments to reflect these changes, but wanted to make sure that the help messages were fine.
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.
nice
Ticket
Changes:
organization
andlocation
flags to beorg-id
andlocation-id
.Testing:
NOTE: The name changes were NOT tested since nothing changed other than var name