Bug #5417
closed
Help screen formatting for commands with long options is hard to read
Added by David Davis over 10 years ago.
Updated over 6 years ago.
Description
See the screenshot. Stuff isn't lined up.
Files
- Status changed from New to Ready For Testing
- Target version set to 1.7.4
- Pull request https://github.com/theforeman/hammer-cli/pull/139 added
- Pull request deleted (
)
- Assignee set to Tomáš Strachota
I did some testing and compared various formats. The most readable seems to be adding more indentation for long options to keep the columns aligned.
E.g.
Usage:
hammer location add-compute-resource [OPTIONS]
Options:
-h, --help print help
--name NAME Location name
--compute-resource COMPUTE_RESOURCE_NAME Compute resource name
--compute-resource-id COMPUTE_RESOURCE_ID
--id ID
- Status changed from Ready For Testing to Closed
- % Done changed from 0 to 100
Also available in: Atom
PDF