Project

General

Profile

Bug #9684

help output for commands with long descriptions don't wrap nicely

Added by Adam Price over 7 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Difficulty:
Triaged:
No
Bugzilla link:
Pull request:
Team Backlog:
Fixed in Releases:
Found in Releases:
In Kanboard:

Description

When looking at hammer's help output for subcommands, those with long descriptions don't word-wrap nicely.


$ hammer content-report --help
Usage:
    hammer content-report [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    subcommand
 [ARG] ...                     subcommand arguments

Subcommands:
 content-host-status           Show the latest subscription status for a list of
content hosts that have reported their subscription status during a specified
time period. Running this report with minimal parameters will return all status
records for all reported content hosts.
 content-host-trend            Show a listing of all subscription status
snapshots from content hosts which have reported their subscription status in the
specified time period.
 status-trend                  Show the per-day counts of content-hosts, grouped
by subscription status, optionally limited to a date range.

Options:
 -h, --help                    print help

I think something like the follow would be much easier to read:


$ hammer content-report --help
Usage:
    hammer content-report [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
 SUBCOMMAND                    subcommand
 [ARG] ...                     subcommand arguments

Subcommands:
 content-host-status           Show the latest subscription status for a list of
                               content hosts that have reported their
                               subscription status during a specified time
                               period. Running this report with minimal
                               parameters will return all status records for all
                               reported content hosts.

 content-host-trend            Show a listing of all subscription status
                               snapshots from content hosts which have reported
                               their subscription status in the specified time
                               period.

 status-trend                  Show the per-day counts of content-hosts, grouped
                               by subscription status, optionally limited to a
                               date range.

Options:
 -h, --help                    print help

Related issues

Related to Hammer CLI - Tracker #2823: Tracker for usability issuesClosed

History

#1 Updated by Tomáš Strachota over 5 years ago

#2 Updated by Ondřej Pražák over 2 years ago

  • Status changed from New to Closed

content-report command is no longer available and I did not find other commands where the description wraps so I will close for now. We can reopen when we identify commands with this issue.

Also available in: Atom PDF