Project

General

Profile

Tracker #27706

Make the options more readable in the command help

Added by Martin Bacovsky over 1 year ago. Updated 6 months ago.

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

67%

Difficulty:
Triaged:
Yes
Bugzilla link:
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

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

Related issues

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

History

#1 Updated by Martin Bacovsky over 1 year ago

  • Team Backlog Hammer added

#3 Updated by Oleh Fedorenko about 1 year ago

  • Related to Feature #24655: Include details about the required options in the help text added

#4 Updated by Oleh Fedorenko about 1 year ago

  • Related to Bug #16225: Allowed combinations of expanded options aren't obvious added

#5 Updated by Oleh Fedorenko about 1 year ago

  • Related to Feature #4128: hammer $command --help should show mandatory and optional parameter differences added

#6 Updated by Oleh Fedorenko 12 months ago

  • Triaged changed from No to Yes
  • % Done set to 0
  • Assignee set to Oleh Fedorenko
  • Tracker changed from Feature to Tracker

#7 Updated by Oleh Fedorenko 12 months ago

  • Status changed from New to Assigned

#8 Updated by Shira Maximov 12 months ago

  • In Kanboard set to yes

Also available in: Atom PDF