Project

General

Profile

Actions

Bug #32783

closed

Hammer documentation for "hammer organization create --help" command has unnecessary and repeated description

Added by Oleh Fedorenko almost 3 years ago. Updated over 2 years ago.

Status:
Closed
Priority:
Normal
Category:
Other commands
Target version:
-
Fixed in Releases:
Found in Releases:
In Kanboard:

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1969748

Description of problem:

Hammer documentation for "hammer organization create --help" command has unnecessary and repeated description of "JSON is acceptable and preferred way for complex parameters" and "Comma separated list of values. Values containing comma should be quoted or escaped with backslash." for every option

Version-Release number of selected component (if applicable):

How reproducible:
100%

Steps to Reproduce:
1. Execute command "hammer organization create --help"

Actual results:
Repeated and unnecessary description for every option like
"Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters"

Expected results:
Only option specific description should be displayed.

Additional info:

Logs:

hammer organization create --help
Usage:
hammer organization create [OPTIONS]

Options:
--compute-resource[s|-ids] Compute resource names/ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--description DESCRIPTION
--domain[s|-ids] Domain names/ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--environment[s|-ids] Environment names/ids (--environment-ids is deprecated: Use --puppet-environment[s|-ids] instead)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters (Deprecated: Use --puppet-environment[s|-ids] instead)
--hostgroup[s|-ids|-titles] Host group names/titles/ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters

Actions #1

Updated by Oleh Fedorenko almost 3 years ago

  • Status changed from New to Assigned
  • Assignee set to Oleh Fedorenko
Actions #2

Updated by The Foreman Bot over 2 years ago

  • Status changed from Assigned to Ready For Testing
  • Pull request https://github.com/theforeman/hammer-cli/pull/349 added
Actions #3

Updated by The Foreman Bot over 2 years ago

  • Pull request https://github.com/theforeman/hammer-cli-foreman/pull/578 added
Actions #4

Updated by Oleh Fedorenko over 2 years ago

  • Blocks Bug #33134: Fix command extensions and tests added
Actions #5

Updated by Oleh Fedorenko over 2 years ago

  • Status changed from Ready For Testing to Assigned
  • Pull request deleted (https://github.com/theforeman/hammer-cli-foreman/pull/578, https://github.com/theforeman/hammer-cli/pull/349)
Actions #6

Updated by The Foreman Bot over 2 years ago

  • Status changed from Assigned to Ready For Testing
  • Pull request https://github.com/theforeman/hammer-cli/pull/350 added
Actions #7

Updated by Oleh Fedorenko over 2 years ago

  • Blocks deleted (Bug #33134: Fix command extensions and tests)
Actions #8

Updated by The Foreman Bot over 2 years ago

  • Pull request https://github.com/theforeman/hammer-cli/pull/352 added
Actions #9

Updated by The Foreman Bot over 2 years ago

  • Fixed in Releases hammer-cli-3.1.0 added
Actions #10

Updated by Oleh Fedorenko over 2 years ago

  • Status changed from Ready For Testing to Closed
Actions

Also available in: Atom PDF