Project

General

Profile

Bug #32783

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

Added by Oleh Fedorenko 8 months ago. Updated 6 months ago.

Status:
Closed
Priority:
Normal
Category:
Other commands
Target version:
-
Team Backlog:
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

Associated revisions

Revision 27d4686d (diff)
Added by Oleh Fedorenko 6 months ago

Fixes #32783 - Extract descs to option details section

Revision d0bedb1a
Added by yifat makias 6 months ago

Merge pull request #350 from ofedoren/bug-32783-add-new-section

Fixes #32783 - Extract descs to option details section

History

#1 Updated by Oleh Fedorenko 7 months ago

  • Assignee set to Oleh Fedorenko
  • Status changed from New to Assigned

#2 Updated by The Foreman Bot 6 months ago

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

#3 Updated by The Foreman Bot 6 months ago

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

#4 Updated by Oleh Fedorenko 6 months ago

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

#5 Updated by Oleh Fedorenko 6 months ago

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

#6 Updated by The Foreman Bot 6 months ago

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

#7 Updated by Oleh Fedorenko 6 months ago

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

#8 Updated by The Foreman Bot 6 months ago

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

#9 Updated by The Foreman Bot 6 months ago

  • Fixed in Releases hammer-cli-3.1.0 added

#10 Updated by Oleh Fedorenko 6 months ago

  • Status changed from Ready For Testing to Closed

Also available in: Atom PDF