chore: Add missing CLI short docstrings (#5175)

Signed-off-by: Simon Behar <[email protected]>
argoproj · Feb 23, 2021 · 8af3595 · 8af3595
1 parent a9c4200
commit 8af3595
Show file tree

Hide file tree

Showing 16 changed files with 37 additions and 32 deletions.
diff --git a/cmd/argo/commands/archive/delete.go b/cmd/argo/commands/archive/delete.go
@@ -12,7 +12,8 @@ import (
 
 func NewDeleteCommand() *cobra.Command {
  command := &cobra.Command{
- Use: "delete UID...",
+ Use: "delete UID...",
+ Short: "delete a workflow in the archive",
  Run: func(cmd *cobra.Command, args []string) {
  ctx, apiClient := client.NewAPIClient()
  serviceClient, err := apiClient.NewArchivedWorkflowServiceClient()

diff --git a/cmd/argo/commands/archive/get.go b/cmd/argo/commands/archive/get.go
@@ -18,7 +18,8 @@ import (
 func NewGetCommand() *cobra.Command {
  var output string
  command := &cobra.Command{
- Use: "get UID",
+ Use: "get UID",
+ Short: "get a workflow in the archive",
  Run: func(cmd *cobra.Command, args []string) {
  if len(args) != 1 {
  cmd.HelpFunc()(cmd, args)

diff --git a/cmd/argo/commands/archive/list.go b/cmd/argo/commands/archive/list.go
@@ -22,7 +22,8 @@ func NewListCommand() *cobra.Command {
  chunkSize int64
  )
  command := &cobra.Command{
- Use: "list",
+ Use: "list",
+ Short: "list workflows in the archive",
  Run: func(cmd *cobra.Command, args []string) {
  ctx, apiClient := client.NewAPIClient()
  serviceClient, err := apiClient.NewArchivedWorkflowServiceClient()

diff --git a/cmd/argo/commands/archive/root.go b/cmd/argo/commands/archive/root.go
@@ -6,7 +6,8 @@ import (
 
 func NewArchiveCommand() *cobra.Command {
  command := &cobra.Command{
- Use: "archive",
+ Use: "archive",
+ Short: "manage the workflow archive",
  Run: func(cmd *cobra.Command, args []string) {
  cmd.HelpFunc()(cmd, args)
  },

diff --git a/cmd/argo/commands/auth/root.go b/cmd/argo/commands/auth/root.go
@@ -6,7 +6,8 @@ import (
 
 func NewAuthCommand() *cobra.Command {
  command := &cobra.Command{
- Use: "auth",
+ Use: "auth",
+ Short: "manage authentication settings",
  Run: func(cmd *cobra.Command, args []string) {
  cmd.HelpFunc()(cmd, args)
  },

diff --git a/cmd/argo/commands/server.go b/cmd/argo/commands/server.go
@@ -45,7 +45,7 @@ func NewServerCommand() *cobra.Command {
 
  command := cobra.Command{
  Use: "server",
- Short: "Start the Argo Server",
+ Short: "start the Argo Server",
  Example: fmt.Sprintf(`
 See %s`, help.ArgoSever),
  Run: func(c *cobra.Command, args []string) {

diff --git a/cmd/argo/commands/version.go b/cmd/argo/commands/version.go
@@ -17,7 +17,7 @@ func NewVersionCommand() *cobra.Command {
  var short bool
  cmd := cobra.Command{
  Use: "version",
- Short: "Print version information",
+ Short: "print version information",
  Run: func(cmd *cobra.Command, args []string) {
  cmdutil.PrintVersion(CLIName, argo.GetVersion(), short)
  if _, ok := os.LookupEnv("ARGO_SERVER"); ok {

diff --git a/docs/cli/argo.md b/docs/cli/argo.md
@@ -100,8 +100,8 @@ argo [flags]
 
 ### SEE ALSO
 
-* [argo archive](argo_archive.md) - 
-* [argo auth](argo_auth.md) - 
+* [argo archive](argo_archive.md) - manage the workflow archive
+* [argo auth](argo_auth.md) - manage authentication settings
 * [argo cluster-template](argo_cluster-template.md) - manipulate cluster workflow templates
 * [argo completion](argo_completion.md) - output shell completion code for the specified shell (bash or zsh)
 * [argo cron](argo_cron.md) - manage cron workflows
@@ -114,13 +114,13 @@ argo [flags]
 * [argo resubmit](argo_resubmit.md) - resubmit one or more workflows
 * [argo resume](argo_resume.md) - resume zero or more workflows
 * [argo retry](argo_retry.md) - retry zero or more workflows
-* [argo server](argo_server.md) - Start the Argo Server
+* [argo server](argo_server.md) - start the Argo Server
 * [argo stop](argo_stop.md) - stop zero or more workflows allowing all exit handlers to run
 * [argo submit](argo_submit.md) - submit a workflow
 * [argo suspend](argo_suspend.md) - suspend zero or more workflow
 * [argo template](argo_template.md) - manipulate workflow templates
 * [argo terminate](argo_terminate.md) - terminate zero or more workflows immediately
-* [argo version](argo_version.md) - Print version information
+* [argo version](argo_version.md) - print version information
 * [argo wait](argo_wait.md) - waits for workflows to complete
 * [argo watch](argo_watch.md) - watch a workflow until it completes
 
diff --git a/docs/cli/argo_archive.md b/docs/cli/argo_archive.md
@@ -1,10 +1,10 @@
 ## argo archive
 
-
+manage the workflow archive
 
 ### Synopsis
 
-
+manage the workflow archive
 
 ```
 argo archive [flags]
@@ -50,7 +50,7 @@ argo archive [flags]
 ### SEE ALSO
 
 * [argo](argo.md) - argo is the command line interface to Argo
-* [argo archive delete](argo_archive_delete.md) - 
-* [argo archive get](argo_archive_get.md) - 
-* [argo archive list](argo_archive_list.md) - 
+* [argo archive delete](argo_archive_delete.md) - delete a workflow in the archive
+* [argo archive get](argo_archive_get.md) - get a workflow in the archive
+* [argo archive list](argo_archive_list.md) - list workflows in the archive
 
diff --git a/docs/cli/argo_archive_delete.md b/docs/cli/argo_archive_delete.md
@@ -1,10 +1,10 @@
 ## argo archive delete
 
-
+delete a workflow in the archive
 
 ### Synopsis
 
-
+delete a workflow in the archive
 
 ```
 argo archive delete UID... [flags]
@@ -49,5 +49,5 @@ argo archive delete UID... [flags]
 
 ### SEE ALSO
 
-* [argo archive](argo_archive.md) - 
+* [argo archive](argo_archive.md) - manage the workflow archive
 
diff --git a/docs/cli/argo_archive_get.md b/docs/cli/argo_archive_get.md
@@ -1,10 +1,10 @@
 ## argo archive get
 
-
+get a workflow in the archive
 
 ### Synopsis
 
-
+get a workflow in the archive
 
 ```
 argo archive get UID [flags]
@@ -50,5 +50,5 @@ argo archive get UID [flags]
 
 ### SEE ALSO
 
-* [argo archive](argo_archive.md) - 
+* [argo archive](argo_archive.md) - manage the workflow archive
 
diff --git a/docs/cli/argo_archive_list.md b/docs/cli/argo_archive_list.md
@@ -1,10 +1,10 @@
 ## argo archive list
 
-
+list workflows in the archive
 
 ### Synopsis
 
-
+list workflows in the archive
 
 ```
 argo archive list [flags]
@@ -52,5 +52,5 @@ argo archive list [flags]
 
 ### SEE ALSO
 
-* [argo archive](argo_archive.md) - 
+* [argo archive](argo_archive.md) - manage the workflow archive
 
diff --git a/docs/cli/argo_auth.md b/docs/cli/argo_auth.md
@@ -1,10 +1,10 @@
 ## argo auth
 
-
+manage authentication settings
 
 ### Synopsis
 
-
+manage authentication settings
 
 ```
 argo auth [flags]

diff --git a/docs/cli/argo_auth_token.md b/docs/cli/argo_auth_token.md
@@ -49,5 +49,5 @@ argo auth token [flags]
 
 ### SEE ALSO
 
-* [argo auth](argo_auth.md) - 
+* [argo auth](argo_auth.md) - manage authentication settings
 
diff --git a/docs/cli/argo_server.md b/docs/cli/argo_server.md
@@ -1,10 +1,10 @@
 ## argo server
 
-Start the Argo Server
+start the Argo Server
 
 ### Synopsis
 
-Start the Argo Server
+start the Argo Server
 
 ```
 argo server [flags]

diff --git a/docs/cli/argo_version.md b/docs/cli/argo_version.md
@@ -1,10 +1,10 @@
 ## argo version
 
-Print version information
+print version information
 
 ### Synopsis
 
-Print version information
+print version information
 
 ```
 argo version [flags]