python-openstackclient

Would top level command help be useful?

Asked by Stuart McLaren on 2016-06-17

If I do 'help' on a top level command, for example 'container':

(openstack) help container
Command "container" matches:
  container create
  container delete
  container list
  container save
  container set
  container show
  container unset

The list of available sub commands are given.

Would it be useful to give some additional context, eg something like:

(openstack) help container

container commands can be used to manipulate Object Store containers.

Command "container" matches:
  container create
  container delete
  container list
  container save
  container set
  container show
  container unset

'Container' is ambiguous and could mean ... docker/lxc container.

Currently:

(openstack) help ptr
Command "ptr" matches:
  ptr record list
  ptr record set
  ptr record show
  ptr record unset

Could be:

(openstack) help ptr

ptr commands can be used to ... (I'm not sure what this is for)

Command "ptr" matches:
  ptr record list
  ptr record set
  ptr record show
  ptr record unset

$ openstack --version
openstack 2.3.1