chore(cli): add some simple help for the standard operations

JohnVillalovos · nejch · commit 5a4a940f42e4 · 2024-05-17T14:01:07.000+02:00
Add help for the following standard operations:
  * list: List the GitLab resources
  * get: Get a GitLab resource
  * create: Create a GitLab resource
  * update: Update a GitLab resource
  * delete: Delete a GitLab resource

For example:
  $ gitlab project-key --help
  usage: gitlab project-key [-h] {list,get,create,update,delete,enable} ...

  options:
    -h, --help            show this help message and exit

  action:
    list
    get
    create
    update
    delete
    enable
                          Action to execute on the GitLab resource.
      list                List the GitLab resources
      get                 Get a GitLab resource
      create              Create a GitLab resource
      update              Update a GitLab resource
      delete              Delete a GitLab resource
diff --git a/gitlab/v4/cli.py b/gitlab/v4/cli.py
@@ -207,12 +207,20 @@ def _populate_sub_parser_by_class(
     mgr_cls = getattr(gitlab.v4.objects, mgr_cls_name)
 
     action_parsers: Dict[str, argparse.ArgumentParser] = {}
-    for action_name in ["list", "get", "create", "update", "delete"]:
+    for action_name, help_text in [
+        ("list", "List the GitLab resources"),
+        ("get", "Get a GitLab resource"),
+        ("create", "Create a GitLab resource"),
+        ("update", "Update a GitLab resource"),
+        ("delete", "Delete a GitLab resource"),
+    ]:
         if not hasattr(mgr_cls, action_name):
             continue
 
         sub_parser_action = sub_parser.add_parser(
-            action_name, conflict_handler="resolve"
+            action_name,
+            conflict_handler="resolve",
+            help=help_text,
         )
         action_parsers[action_name] = sub_parser_action
         sub_parser_action.add_argument("--sudo", required=False)
