From 1686dc54f09b6e77b1de3abc708c297710987a04 Mon Sep 17 00:00:00 2001
From: Dean Troyer <dtroyer@gmail.com>
Date: Mon, 3 Apr 2017 16:15:14 -0500
Subject: Help/docs cleanups: marker, limit, ip-address metavars

Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
  type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
  in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text

Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
---
 openstackclient/volume/v1/volume.py          | 2 +-
 openstackclient/volume/v2/backup.py          | 4 ++--
 openstackclient/volume/v2/snapshot.py        | 4 ++--
 openstackclient/volume/v2/volume.py          | 4 ++--
 openstackclient/volume/v2/volume_snapshot.py | 4 ++--
 openstackclient/volume/v2/volume_type.py     | 2 +-
 6 files changed, 10 insertions(+), 10 deletions(-)

(limited to 'openstackclient/volume')

diff --git a/openstackclient/volume/v1/volume.py b/openstackclient/volume/v1/volume.py
index 8e1097f5..0121e059 100644
--- a/openstackclient/volume/v1/volume.py
+++ b/openstackclient/volume/v1/volume.py
@@ -291,7 +291,7 @@ class ListVolume(command.Lister):
             '--limit',
             type=int,
             action=parseractions.NonNegativeAction,
-            metavar='<limit>',
+            metavar='<num-volumes>',
             help=_('Maximum number of volumes to display'),
         )
         return parser
diff --git a/openstackclient/volume/v2/backup.py b/openstackclient/volume/v2/backup.py
index 00389fcb..60633a70 100644
--- a/openstackclient/volume/v2/backup.py
+++ b/openstackclient/volume/v2/backup.py
@@ -202,14 +202,14 @@ class ListVolumeBackup(command.Lister):
         )
         parser.add_argument(
             '--marker',
-            metavar='<marker>',
+            metavar='<volume-backup>',
             help=_('The last backup of the previous page (name or ID)'),
         )
         parser.add_argument(
             '--limit',
             type=int,
             action=parseractions.NonNegativeAction,
-            metavar='<limit>',
+            metavar='<num-backups>',
             help=_('Maximum number of backups to display'),
         )
         parser.add_argument(
diff --git a/openstackclient/volume/v2/snapshot.py b/openstackclient/volume/v2/snapshot.py
index a18887e3..82b31033 100644
--- a/openstackclient/volume/v2/snapshot.py
+++ b/openstackclient/volume/v2/snapshot.py
@@ -146,14 +146,14 @@ class ListSnapshot(command.Lister):
         )
         parser.add_argument(
             '--marker',
-            metavar='<marker>',
+            metavar='<snapshot>',
             help=_('The last snapshot ID of the previous page'),
         )
         parser.add_argument(
             '--limit',
             type=int,
             action=parseractions.NonNegativeAction,
-            metavar='<limit>',
+            metavar='<num-snapshots>',
             help=_('Maximum number of snapshots to display'),
         )
         return parser
diff --git a/openstackclient/volume/v2/volume.py b/openstackclient/volume/v2/volume.py
index c361d700..2b6c966d 100644
--- a/openstackclient/volume/v2/volume.py
+++ b/openstackclient/volume/v2/volume.py
@@ -341,14 +341,14 @@ class ListVolume(command.Lister):
         )
         parser.add_argument(
             '--marker',
-            metavar='<marker>',
+            metavar='<volume>',
             help=_('The last volume ID of the previous page'),
         )
         parser.add_argument(
             '--limit',
             type=int,
             action=parseractions.NonNegativeAction,
-            metavar='<limit>',
+            metavar='<num-volumes>',
             help=_('Maximum number of volumes to display'),
         )
         return parser
diff --git a/openstackclient/volume/v2/volume_snapshot.py b/openstackclient/volume/v2/volume_snapshot.py
index f12cfed9..804c8291 100644
--- a/openstackclient/volume/v2/volume_snapshot.py
+++ b/openstackclient/volume/v2/volume_snapshot.py
@@ -180,14 +180,14 @@ class ListVolumeSnapshot(command.Lister):
         )
         parser.add_argument(
             '--marker',
-            metavar='<marker>',
+            metavar='<volume-snapshot>',
             help=_('The last snapshot ID of the previous page'),
         )
         parser.add_argument(
             '--limit',
             type=int,
             action=parseractions.NonNegativeAction,
-            metavar='<limit>',
+            metavar='<num-snapshots>',
             help=_('Maximum number of snapshots to display'),
         )
         parser.add_argument(
diff --git a/openstackclient/volume/v2/volume_type.py b/openstackclient/volume/v2/volume_type.py
index 8d2901f2..64c4d652 100644
--- a/openstackclient/volume/v2/volume_type.py
+++ b/openstackclient/volume/v2/volume_type.py
@@ -544,7 +544,7 @@ class UnsetVolumeType(command.Command):
             '--project',
             metavar='<project>',
             help=_('Removes volume type access to project (name or ID) '
-                   ' (admin only)'),
+                   '(admin only)'),
         )
         identity_common.add_project_domain_option_to_parser(parser)
         parser.add_argument(
-- 
cgit v1.2.1