Merge pull request #58 from skanthed/clarify-help-text

Clarify help text for --all and --status flags in esi lease list and offer list
CCI-MOC · Jun 24, 2024 · 005dd5f · 005dd5f
2 parents 6b3fadd + a673800
commit 005dd5f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/esileapclient/osc/v1/lease.py b/esileapclient/osc/v1/lease.py
@@ -143,7 +143,11 @@ def get_parser(self, prog_name):
             '--status',
             dest='status',
             required=False,
-            help="Show all leases with given status.")
+            help="Show all leases with the given status. "
+                 "Use --status 'any' to show leases with any status "
+                 "(by default, leases with 'created', 'active', 'error', "
+                 "'wait_cancel', 'wait_expire', and 'wait_fulfill' statuses "
+                 "are shown).")
         parser.add_argument(
             '--offer-uuid',
             dest='offer_uuid',

diff --git a/esileapclient/osc/v1/offer.py b/esileapclient/osc/v1/offer.py
@@ -107,7 +107,10 @@ def get_parser(self, prog_name):
             '--status',
             dest='status',
             required=False,
-            help="Show all offers with given status.")
+            help="Show all offers with the given status. "
+                 "Use --status 'any' to show offers with any status "
+                 "(by default, offers with 'available' and 'error' statuses"
+                 "are shown).")
         parser.add_argument(
             '--time-range',
             dest='time_range',