Project

General

Profile

Actions

Tracker #27706

open

Make the options more readable in the command help

Added by Martin Bacovsky over 5 years ago. Updated over 4 years ago.

Status:
Assigned
Priority:
Normal
Category:
User experience
Target version:
-
% Done:

67%

Difficulty:
Triaged:
Yes
Team Backlog:
Hammer
Fixed in Releases:
Found in Releases:
In Kanboard:
yes

Description

Currently:

# hammer capsule update --help

Actual results:
===
...
 --location LOCATION_NAME                  Location name
 --location-id LOCATION_ID
 --location-ids LOCATION_IDS               REPLACE locations with given ids
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --location-title LOCATION_TITLE           Location title
 --location-titles LOCATION_TITLES         Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --locations LOCATION_NAMES                Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --name NAME                               Name to search by
 --new-name NEW_NAME
 --organization ORGANIZATION_NAME          Organization name
 --organization-id ORGANIZATION_ID         Organization ID
 --organization-ids ORGANIZATION_IDS       REPLACE organizations with given ids.
                                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --organization-title ORGANIZATION_TITLE   Organization title
 --organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash
 --organizations ORGANIZATION_NAMES        Comma separated list of values. Values containing comma should be quoted or escaped with backslash
...
===

It is not easy to read and understand what options serve what purpose. It needs to be simplified and the descriptions needs to be more informative.
More detailed information could be provided by a --full-help.


Subtasks 3 (1 open2 closed)

Feature #28440: Squeeze expanded options in help outputClosedOleh FedorenkoActions
Feature #28441: Add information about required options in help outputDuplicateOleh FedorenkoActions
Feature #28442: Improve option descriptions in help outputNewActions

Related issues 3 (3 open0 closed)

Related to Hammer CLI - Feature #24655: Include details about the required options in the help text AssignedOleh FedorenkoActions
Related to Hammer CLI - Bug #16225: Allowed combinations of expanded options aren't obviousNewActions
Related to Hammer CLI - Feature #4128: hammer $command --help should show mandatory and optional parameter differencesNewActions
Actions

Also available in: Atom PDF