queue: cleanup help/usage to match docs

This commit is contained in:
Peter Rowlands
2022-07-12 21:39:49 +09:00
committed by Peter Rowlands (변기호)
parent ed593493df
commit 5a6e363c16
4 changed files with 20 additions and 9 deletions
+1 -1
View File
@@ -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],
+4 -1
View File
@@ -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",
+14 -6
View File
@@ -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)
+1 -1
View File
@@ -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],