openstack/python-openstackclient
Code Issues Proposed changes

Fix really long help strings

Browse Source 
Each command should have a summary line followed by a longer
description, if needed. Some commands were not following this. Fix them.

Change-Id: If1ce7654037d192626460f34c069ea0979919b9b
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane 2022-12-12 18:02:54 +00:00
parent 29129a7715
commit 5afe48040c
4 changed files with 33 additions and 35 deletions
openstackclient
common
quota.py
compute/v2
server.pyservice.py
volume/v2
backup_record.py

10
openstackclient/common/quota.py

@ -749,12 +749,10 @@ class SetQuota(common.NetDetectionMixin, command.Command):
class ShowQuota(command.Lister): class ShowQuota(command.Lister):
_description = _( _description = _("""Show quotas for project or class.
"Show quotas for project or class. "
"Specify ``--os-compute-api-version 2.50`` or higher to see " Specify ``--os-compute-api-version 2.50`` or higher to see ``server-groups``
"``server-groups`` and ``server-group-members`` output for a given " and ``server-group-members`` output for a given quota class.""")
"quota class."
)
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)

34
openstackclient/compute/v2/server.py

@ -555,10 +555,10 @@ class AddServerSecurityGroup(command.Command):
class AddServerVolume(command.ShowOne): class AddServerVolume(command.ShowOne):
_description = _( _description = _("""Add volume to server.
"Add volume to server. "
"Specify ``--os-compute-api-version 2.20`` or higher to add a volume " Specify ``--os-compute-api-version 2.20`` or higher to add a volume to a server
"to a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.") with status ``SHELVED`` or ``SHELVED_OFFLOADED``.""")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(AddServerVolume, self).get_parser(prog_name) parser = super(AddServerVolume, self).get_parser(prog_name)
@ -3705,11 +3705,10 @@ class RemoveServerSecurityGroup(command.Command):
class RemoveServerVolume(command.Command): class RemoveServerVolume(command.Command):
_description = _( _description = _("""Remove volume from server.
"Remove volume from server. "
"Specify ``--os-compute-api-version 2.20`` or higher to remove a " Specify ``--os-compute-api-version 2.20`` or higher to remove a
"volume from a server with status ``SHELVED`` or " volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.""")
"``SHELVED_OFFLOADED``.")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(RemoveServerVolume, self).get_parser(prog_name) parser = super(RemoveServerVolume, self).get_parser(prog_name)
@ -3746,11 +3745,10 @@ class RemoveServerVolume(command.Command):
class RescueServer(command.Command): class RescueServer(command.Command):
_description = _( _description = _("""Put server in rescue mode.
"Put server in rescue mode. "
"Specify ``--os-compute-api-version 2.87`` or higher to rescue a " Specify ``--os-compute-api-version 2.87`` or higher to rescue a
"server booted from a volume." server booted from a volume.""")
)
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(RescueServer, self).get_parser(prog_name) parser = super(RescueServer, self).get_parser(prog_name)
@ -4294,10 +4292,10 @@ class ShelveServer(command.Command):
class ShowServer(command.ShowOne): class ShowServer(command.ShowOne):
_description = _( _description = _("""Show server details.
"Show server details. Specify ``--os-compute-api-version 2.47`` "
"or higher to see the embedded flavor information for the server." Specify ``--os-compute-api-version 2.47`` or higher to see the embedded flavor
) information for the server.""")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ShowServer, self).get_parser(prog_name) parser = super(ShowServer, self).get_parser(prog_name)

10
openstackclient/compute/v2/service.py

@ -71,11 +71,11 @@ class DeleteService(command.Command):
class ListService(command.Lister): class ListService(command.Lister):
_description = _("List compute services. Using " _description = _("""List compute services.
"``--os-compute-api-version`` 2.53 or greater will "
"return the ID as a UUID value which can be used to " Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a UUID
"uniquely identify the service in a multi-cell " value which can be used to uniquely identify the service in a multi-cell
"deployment.") deployment.""")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ListService, self).get_parser(prog_name) parser = super(ListService, self).get_parser(prog_name)

14
openstackclient/volume/v2/backup_record.py

@ -26,9 +26,10 @@ LOG = logging.getLogger(__name__)
class ExportBackupRecord(command.ShowOne): class ExportBackupRecord(command.ShowOne):
_description = _('Export volume backup details. Backup information can be ' _description = _("""Export volume backup details.
'imported into a new service instance to be able to '
'restore.') Backup information can be imported into a new service instance to be able to
restore.""")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ExportBackupRecord, self).get_parser(prog_name) parser = super(ExportBackupRecord, self).get_parser(prog_name)
@ -54,9 +55,10 @@ class ExportBackupRecord(command.ShowOne):
class ImportBackupRecord(command.ShowOne): class ImportBackupRecord(command.ShowOne):
_description = _('Import volume backup details. Exported backup details ' _description = _("""Import volume backup details.
'contain the metadata necessary to restore to a new or '
'rebuilt service instance') Exported backup details contain the metadata necessary to restore to a new or
rebuilt service instance""")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super(ImportBackupRecord, self).get_parser(prog_name) parser = super(ImportBackupRecord, self).get_parser(prog_name)