Project

General

Profile

Feature #28441

Tracker #27706: Make the options more readable in the command help

Add information about required options in help output

Added by Oleh Fedorenko about 2 months ago. Updated 25 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
User experience
Target version:
-
Difficulty:
Triaged:
Yes
Bugzilla link:
Pull request:
Team Backlog:
Fixed in Releases:
Found in Releases:
In Kanboard:

Description

There's no way to mark options for identifiers of resources that are required, because they can exist in multiple
complementary variants.

In combinations like (`--organization`, `--organization-id`, `--organization-label`) or (`--name` and `--id`)
there is only one of the options required, therefore we can't simply put "(required)" into the option descriptions
for each of them (the standard way in Clamp).

Another issue is dependencies between options.
Most of resources in Katello are scoped to some other resource (to organization at minimum) and their name and/or label identifiers are
unique only in this scope. When this is translated to command options necessary for resolving names to ids it creates dependencies.

History

#1 Updated by Shira Maximov about 1 month ago

  • In Kanboard set to yes

Changing the

#2 Updated by Shira Maximov about 1 month ago

  • In Kanboard changed from yes to no

#3 Updated by Shira Maximov about 1 month ago

  • In Kanboard deleted (no)

#4 Updated by Shira Maximov about 1 month ago

  • In Kanboard set to yes

Changing in_kanboard field to yes

#5 Updated by Shira Maximov 25 days ago

  • In Kanboard deleted (yes)
  • Found in Releases hammer-cli-0.15.1 added

Also available in: Atom PDF