Merge "Fix really long help strings"

Zuul · openstack-gerrit · commit 14dff075ff19 · 2023-02-22T12:32:16.000Z
diff --git a/openstackclient/common/quota.py b/openstackclient/common/quota.py
@@ -749,12 +749,10 @@ def take_action(self, parsed_args):
 
 
 class ShowQuota(command.Lister):
-    _description = _(
-        "Show quotas for project or class. "
-        "Specify ``--os-compute-api-version 2.50`` or higher to see "
-        "``server-groups`` and ``server-group-members`` output for a given "
-        "quota class."
-    )
+    _description = _("""Show quotas for project or class.
+
+Specify ``--os-compute-api-version 2.50`` or higher to see ``server-groups``
+and ``server-group-members`` output for a given quota class.""")
 
     def get_parser(self, prog_name):
         parser = super().get_parser(prog_name)
diff --git a/openstackclient/compute/v2/server.py b/openstackclient/compute/v2/server.py
@@ -608,10 +608,10 @@ def take_action(self, parsed_args):
 
 
 class AddServerVolume(command.ShowOne):
-    _description = _(
-        "Add volume to server. "
-        "Specify ``--os-compute-api-version 2.20`` or higher to add a volume "
-        "to a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.")
+    _description = _("""Add volume to server.
+
+Specify ``--os-compute-api-version 2.20`` or higher to add a volume to a server
+with status ``SHELVED`` or ``SHELVED_OFFLOADED``.""")
 
     def get_parser(self, prog_name):
         parser = super(AddServerVolume, self).get_parser(prog_name)
@@ -3757,11 +3757,10 @@ def take_action(self, parsed_args):
 
 
 class RemoveServerVolume(command.Command):
-    _description = _(
-        "Remove volume from server. "
-        "Specify ``--os-compute-api-version 2.20`` or higher to remove a "
-        "volume from a server with status ``SHELVED`` or "
-        "``SHELVED_OFFLOADED``.")
+    _description = _("""Remove volume from server.
+
+Specify ``--os-compute-api-version 2.20`` or higher to remove a
+volume from a server with status ``SHELVED`` or ``SHELVED_OFFLOADED``.""")
 
     def get_parser(self, prog_name):
         parser = super(RemoveServerVolume, self).get_parser(prog_name)
@@ -3798,11 +3797,10 @@ def take_action(self, parsed_args):
 
 
 class RescueServer(command.Command):
-    _description = _(
-        "Put server in rescue mode. "
-        "Specify ``--os-compute-api-version 2.87`` or higher to rescue a "
-        "server booted from a volume."
-    )
+    _description = _("""Put server in rescue mode.
+
+Specify ``--os-compute-api-version 2.87`` or higher to rescue a
+server booted from a volume.""")
 
     def get_parser(self, prog_name):
         parser = super(RescueServer, self).get_parser(prog_name)
@@ -4342,10 +4340,10 @@ def _show_progress(progress):
 
 
 class ShowServer(command.ShowOne):
-    _description = _(
-        "Show server details. Specify ``--os-compute-api-version 2.47`` "
-        "or higher to see the embedded flavor information for the server."
-    )
+    _description = _("""Show server details.
+
+Specify ``--os-compute-api-version 2.47`` or higher to see the embedded flavor
+information for the server.""")
 
     def get_parser(self, prog_name):
         parser = super(ShowServer, self).get_parser(prog_name)
diff --git a/openstackclient/compute/v2/service.py b/openstackclient/compute/v2/service.py
@@ -71,11 +71,11 @@ def take_action(self, parsed_args):
 
 
 class ListService(command.Lister):
-    _description = _("List compute services. Using "
-                     "``--os-compute-api-version`` 2.53 or greater will "
-                     "return the ID as a UUID value which can be used to "
-                     "uniquely identify the service in a multi-cell "
-                     "deployment.")
+    _description = _("""List compute services.
+
+Using ``--os-compute-api-version`` 2.53 or greater will return the ID as a UUID
+value which can be used to uniquely identify the service in a multi-cell
+deployment.""")
 
     def get_parser(self, prog_name):
         parser = super(ListService, self).get_parser(prog_name)
diff --git a/openstackclient/volume/v2/backup_record.py b/openstackclient/volume/v2/backup_record.py
@@ -26,9 +26,10 @@
 
 
 class ExportBackupRecord(command.ShowOne):
-    _description = _('Export volume backup details. Backup information can be '
-                     'imported into a new service instance to be able to '
-                     'restore.')
+    _description = _("""Export volume backup details.
+
+Backup information can be imported into a new service instance to be able to
+restore.""")
 
     def get_parser(self, prog_name):
         parser = super(ExportBackupRecord, self).get_parser(prog_name)
@@ -54,9 +55,10 @@ def take_action(self, parsed_args):
 
 
 class ImportBackupRecord(command.ShowOne):
-    _description = _('Import volume backup details. Exported backup details '
-                     'contain the metadata necessary to restore to a new or '
-                     'rebuilt service instance')
+    _description = _("""Import volume backup details.
+
+Exported backup details contain the metadata necessary to restore to a new or
+rebuilt service instance""")
 
     def get_parser(self, prog_name):
         parser = super(ImportBackupRecord, self).get_parser(prog_name)
