Skip to content

Commit 5b67241

Browse files
authored
Scheduler: add short help output (#1576)
Signed-off-by: joshvanl <[email protected]>
1 parent 7a11cce commit 5b67241

File tree

4 files changed

+7
-3
lines changed

4 files changed

+7
-3
lines changed

cmd/scheduler/delete.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ import (
2323
var DeleteCmd = &cobra.Command{
2424
Use: "delete",
2525
Aliases: []string{"d", "del"},
26-
Short: `Delete one of more jobs from scheduler.
26+
Short: "Delete one or more jobs from scheduler.",
27+
Long: `Delete one of more jobs from scheduler.
2728
Job names are formatted by their type, app ID, then identifier.
2829
Actor reminders require the actor type, actor ID, then reminder name, separated by /.
2930
Workflow reminders require the app ID, instance ID, then reminder name, separated by /.

cmd/scheduler/deleteall.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ import (
2323
var DeleteAllCmd = &cobra.Command{
2424
Use: "delete-all",
2525
Aliases: []string{"da", "delall"},
26-
Short: `Delete all scheduled jobs in the specified namespace of a particular filter.
26+
Short: "Delete all scheduled jobs in the specified namespace of a particular filter.",
27+
Long: `Delete all scheduled jobs in the specified namespace of a particular filter.
2728
Accepts a single key as an argument. Deletes all jobs which match the filter key.
2829
`,
2930
Args: cobra.ExactArgs(1),

cmd/scheduler/get.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ var (
3131
var GetCmd = &cobra.Command{
3232
Use: "get",
3333
Aliases: []string{"g", "ge"},
34-
Short: `Get a scheduled app job or actor reminder in Scheduler.
34+
Short: "Get scheduled app job or actor reminder in Scheduler.",
35+
Long: `Get a scheduled app job or actor reminder in Scheduler.
3536
Job names are formatted by their type, app ID, then identifier.
3637
Actor reminders require the actor type, actor ID, then reminder name, separated by /.
3738
Workflow reminders require the app ID, instance ID, then reminder name, separated by /.

cmd/scheduler/list.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ var (
3434
var ListCmd = &cobra.Command{
3535
Use: "list",
3636
Short: "List scheduled jobs in Scheduler.",
37+
Long: `List scheduled jobs in Scheduler.`,
3738
Args: cobra.NoArgs,
3839
RunE: func(cmd *cobra.Command, args []string) error {
3940
ctx := signals.Context()

0 commit comments

Comments
 (0)