From 5a6e363c16c16ca93886643db466d04965202c43 Mon Sep 17 00:00:00 2001
From: Peter Rowlands <peter@pmrowla.com>
Date: Tue, 5 Jul 2022 14:29:52 +0900
Subject: [PATCH] queue: cleanup help/usage to match docs

---
 dvc/commands/queue/kill.py   |  2 +-
 dvc/commands/queue/logs.py   |  5 ++++-
 dvc/commands/queue/remove.py | 20 ++++++++++++++------
 dvc/commands/queue/stop.py   |  2 +-
 4 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/dvc/commands/queue/kill.py b/dvc/commands/queue/kill.py
index 52fe70cd5..098c09119 100644
--- a/dvc/commands/queue/kill.py
+++ b/dvc/commands/queue/kill.py
@@ -17,7 +17,7 @@ class CmdQueueKill(CmdBase):
 
 
 def add_parser(queue_subparsers, parent_parser):
-    QUEUE_KILL_HELP = "Kill tasks in experiments queue."
+    QUEUE_KILL_HELP = "Kill actively running experiment queue tasks."
     queue_kill_parser = queue_subparsers.add_parser(
         "kill",
         parents=[parent_parser],
diff --git a/dvc/commands/queue/logs.py b/dvc/commands/queue/logs.py
index 6a722321c..e970f217a 100644
--- a/dvc/commands/queue/logs.py
+++ b/dvc/commands/queue/logs.py
@@ -21,7 +21,9 @@ class CmdQueueLogs(CmdBase):
 
 
 def add_parser(queue_subparsers, parent_parser):
-    QUEUE_LOGS_HELP = "Show output logs for a task in the experiments queue."
+    QUEUE_LOGS_HELP = (
+        "Show output logs for running and completed experiment queue tasks."
+    )
     queue_logs_parser = queue_subparsers.add_parser(
         "logs",
         parents=[parent_parser],
@@ -35,6 +37,7 @@ def add_parser(queue_subparsers, parent_parser):
         help=(
             "Text encoding for log output. Defaults to system locale encoding."
         ),
+        metavar="<encoding>",
     )
     queue_logs_parser.add_argument(
         "-f",
diff --git a/dvc/commands/queue/remove.py b/dvc/commands/queue/remove.py
index 635f80e64..c3b8bbe5b 100644
--- a/dvc/commands/queue/remove.py
+++ b/dvc/commands/queue/remove.py
@@ -31,7 +31,7 @@ class CmdQueueRemove(CmdBase):
 
 def add_parser(queue_subparsers, parent_parser):
 
-    QUEUE_REMOVE_HELP = "Remove tasks in experiments queue."
+    QUEUE_REMOVE_HELP = "Remove queued and completed tasks from the queue."
     queue_remove_parser = queue_subparsers.add_parser(
         "remove",
         parents=[parent_parser],
@@ -40,21 +40,29 @@ def add_parser(queue_subparsers, parent_parser):
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )
     queue_remove_parser.add_argument(
-        "--all", action="store_true", help="Remove all tasks."
+        "--all",
+        action="store_true",
+        help="Remove all queued and completed tasks from the queue.",
     )
     queue_remove_parser.add_argument(
-        "--queued", action="store_true", help="Remove all tasks in queue."
+        "--queued",
+        action="store_true",
+        help="Remove all queued tasks from the queue.",
     )
     queue_remove_parser.add_argument(
-        "--success", action="store_true", help="Remove all successful tasks."
+        "--success",
+        action="store_true",
+        help="Remove all successful tasks from the queue.",
     )
     queue_remove_parser.add_argument(
-        "--failed", action="store_true", help="Remove all failed tasks."
+        "--failed",
+        action="store_true",
+        help="Remove all failed tasks from the queue.",
     )
     queue_remove_parser.add_argument(
         "task",
         nargs="*",
-        help="Tasks in queue to remove.",
+        help="Tasks to remove.",
         metavar="<task>",
     )
     queue_remove_parser.set_defaults(func=CmdQueueRemove)
diff --git a/dvc/commands/queue/stop.py b/dvc/commands/queue/stop.py
index dea6d5a4f..04f474311 100644
--- a/dvc/commands/queue/stop.py
+++ b/dvc/commands/queue/stop.py
@@ -27,7 +27,7 @@ class CmdQueueStop(CmdBase):
 
 def add_parser(queue_subparsers, parent_parser):
 
-    QUEUE_STOP_HELP = "Stop experiments queue workers."
+    QUEUE_STOP_HELP = "Stop all experiments task queue workers."
     queue_stop_parser = queue_subparsers.add_parser(
         "stop",
         parents=[parent_parser],