yahoo-eng-team team mailing list archive

[Scott Devoid <devoid@xxxxxxx>]

Public bug reported:

The nova-manage command exposes the action_args options during the usage
output for command.

E.g.
$ nova-manage network modify -h
usage: nova-manage network modify [-h] [--fixed_range <x.x.x.x/yy>]
                                  [--project <project name>] [--host <host>]
                                  [--disassociate-project]
                                  [--disassociate-host]
                                  [action_args [action_args ...]]

positional arguments:
  action_args

<snip>

This can cause confusion as users naturally expect there to be more
"actions" on commands like "modify". Even in straightforward cases, this
positional argument leaks into usage.

$ nova-manage db version -h
usage: nova-manage db version [-h] [action_args [action_args ...]]

positional arguments:
  action_args

Please consider suppressing documentation on action_args. In addition,
expose the __doc__ strings for these functions, which is done in the
nova command.

** Affects: nova
     Importance: Undecided
         Status: New


** Tags: low-hanging-fruit nova-manage user-experience ux

** Project changed: barbican => nova

** Tags added: low-hanging-fruit user-experience

** Tags added: nova-manage ux

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to OpenStack Compute (nova).
https://bugs.launchpad.net/bugs/1260538

Title:
  nova-manage useage exposes action-args

Status in OpenStack Compute (Nova):
  New

Bug description:
  The nova-manage command exposes the action_args options during the
  usage output for command.

  E.g.
  $ nova-manage network modify -h
  usage: nova-manage network modify [-h] [--fixed_range <x.x.x.x/yy>]
                                    [--project <project name>] [--host <host>]
                                    [--disassociate-project]
                                    [--disassociate-host]
                                    [action_args [action_args ...]]

  positional arguments:
    action_args

  <snip>

  This can cause confusion as users naturally expect there to be more
  "actions" on commands like "modify". Even in straightforward cases,
  this positional argument leaks into usage.

  $ nova-manage db version -h
  usage: nova-manage db version [-h] [action_args [action_args ...]]

  positional arguments:
    action_args

  Please consider suppressing documentation on action_args. In addition,
  expose the __doc__ strings for these functions, which is done in the
  nova command.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nova/+bug/1260538/+subscriptions