Project

General

Profile

Actions

Bug #26960

closed

The --fields option lacks help

Added by Martin Bacovsky almost 5 years ago. Updated almost 5 years ago.

Status:
Closed
Priority:
Normal
Category:
Documentation
Target version:
-
Difficulty:
medium
Triaged:
No
Team Backlog:
Fixed in Releases:
Found in Releases:
In Kanboard:

Description

The --fields option accepts field names or predefined sets. it is not clear what values are available and what fields are printed for specific sets.

I'd love to see some help extension when --fields is defined on the command showing e.g. table like:
currently it is not visible for a user what fields are in which sets. I'd love to see some help extension when --fields is defined on the command showing e.g. table like:

Options:
  --fileds    FIELDS  Show specified fileds or predefined filed sets only. (See below)

...

Predefined field sets:
+--------+-----+---------+------+
| Fields | ALL | DEFAULT | THIN |
+--------+-----+---------+------+
| Id     |  x  |    x    |  x   |
| Name   |  x  |    x    |  x   |
| Param1 |  x  |    x    |      |
| Param2 |  x  |         |      |
+--------+-----+---------+------+

See more context in https://github.com/theforeman/hammer-cli/pull/276#issuecomment-452133084

Actions

Also available in: Atom PDF