diff options
| author | Eric Fried <openstack@fried.cc> | 2019-10-29 16:22:18 -0500 |
|---|---|---|
| committer | Eric Fried <openstack@fried.cc> | 2019-11-05 07:09:05 -0600 |
| commit | 4c0f3bfa89dfc9f207c4f6d6dc6ded85b86fee87 (patch) | |
| tree | 20538d81091a5eeaf0818bb02e936fb2a46cb996 /openstackclient/common/versions.py | |
| parent | c7dbe857055a04402f12dfaa3b261b0ecbf86d7c (diff) | |
| download | python-openstackclient-4c0f3bfa89dfc9f207c4f6d6dc6ded85b86fee87.tar.gz | |
common: autogenerate docs
$namespace = openstack.common
The subcommand documents for $namespace were hardcoded and thus prone to
drift over time. This commit removes the hardcoded content and uses the
autoprogram-cliff directive to generate them automatically from the
subcommand configuration classes.
This incorporates a correction to `openstack versions show`: The command
`openstack versions show --help` showed a copy/paste error, using
<region-name> for the metavar for both --service and --status. Fix.
Change-Id: I7658fed40d71f4c20ee27908ade433534657cfe5
Co-Authored-By: Pierre Prinetti <pierreprinetti@redhat.com>
Co-Authored-By: Matt Riedemann <mriedem.os@gmail.com>
Diffstat (limited to 'openstackclient/common/versions.py')
| -rw-r--r-- | openstackclient/common/versions.py | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/openstackclient/common/versions.py b/openstackclient/common/versions.py index e6781bc6..3acd9f73 100644 --- a/openstackclient/common/versions.py +++ b/openstackclient/common/versions.py @@ -46,14 +46,21 @@ class ShowVersions(command.Lister): parser.add_argument( '--service', metavar='<service>', - help=_('Show versions for a specific service.'), + help=_('Show versions for a specific service. The argument should ' + 'be either an exact match to what is in the catalog or a ' + 'known official value or alias from ' + 'service-types-authority ' + '(https://service-types.openstack.org/)'), ) parser.add_argument( '--status', metavar='<status>', - help=_('Show versions for a specific status.' - ' [Valid values are SUPPORTED, CURRENT,' - ' DEPRECATED, EXPERIMENTAL]'), + help=_("""Show versions for a specific status. Valid values are: + +- SUPPORTED +- CURRENT +- DEPRECATED +- EXPERIMENTAL""") ) return parser |