search

BrobridgeOrg / gravity-cli

Gravity CLI
MIT License
2 stars 3 forks source link

Issues with command help messages #11

Open Eeec7777 opened 2 weeks ago

Eeec7777 commented 2 weeks ago

Version: [47ca8b6]

Issue 1: Duplicate (default true) in Command Usage for token create and token update

In the command usage for token create and token update, the --enabled flag description includes two (default true). This occurs because both the manual description and Cobra automatically append (default true).

Reproduce:

  1. Run token create -h or token update -h.
  2. The usage for the --enabled flag contains two (default true). image

Suggested Solution:

Remove the manually added (default true) from the flag description for both commands.

Issue 2: Incomplete description for --enabled in product update

The description for the --enabled flag in the product update command is missing a character and default prompt.

Reproduce:

  1. Run product update -h.
  2. The usage for the --enabled flag reads "Enable produc". image

Suggested Solution:

Correct the description to "Enable product (default false)".

Issue 3: Duplicate default prompt and missing usage information for product sub

The description for the --partitions flag in the product sub command includes two default value prompt. Additionally, the usage information should include a prompt that multiple values can be specified, separated by commas.

Reproduce:

  1. Run product sub -h.
  2. The usage for the --partitions flag contains duplicate default prompts and lacks information on specifying multiple values. image
william-wyliang commented 2 weeks ago

These issues should be easily fixed. Please consider contributing by sending your PRs.