From 849e647ef1f08bb5761001912f95fab31d958328 Mon Sep 17 00:00:00 2001 From: Martin Polden Date: Thu, 12 Oct 2023 15:38:55 +0200 Subject: Minor improvements to wording and consistency --- client/go/internal/cli/cmd/clone.go | 4 ++-- client/go/internal/cli/cmd/config.go | 4 ++-- client/go/internal/cli/cmd/curl.go | 1 + client/go/internal/cli/cmd/destroy.go | 4 ++-- client/go/internal/cli/cmd/feed.go | 4 ++-- client/go/internal/cli/cmd/version.go | 2 +- client/go/internal/cli/cmd/visit.go | 4 ++-- 7 files changed, 12 insertions(+), 11 deletions(-) (limited to 'client/go') diff --git a/client/go/internal/cli/cmd/clone.go b/client/go/internal/cli/cmd/clone.go index 007a99c1f96..8fd12eb9e6e 100644 --- a/client/go/internal/cli/cmd/clone.go +++ b/client/go/internal/cli/cmd/clone.go @@ -31,8 +31,8 @@ func newCloneCmd(cli *CLI) *cobra.Command { ) cmd := &cobra.Command{ Use: "clone sample-application-path target-directory", - Short: "Create files and directory structure for a new Vespa application from a sample application", - Long: `Create files and directory structure for a new Vespa application + Short: "Create files and directory structure from a Vespa sample application", + Long: `Create files and directory structure from a Vespa sample application from a sample application. Sample applications are downloaded from diff --git a/client/go/internal/cli/cmd/config.go b/client/go/internal/cli/cmd/config.go index b1df8d123c2..cfadc6d32c5 100644 --- a/client/go/internal/cli/cmd/config.go +++ b/client/go/internal/cli/cmd/config.go @@ -30,8 +30,8 @@ const ( func newConfigCmd() *cobra.Command { return &cobra.Command{ Use: "config", - Short: "Configure persistent values for global flags", - Long: `Configure persistent values for global flags. + Short: "Manage persistent values for global flags", + Long: `Manage persistent values for global flags. This command allows setting persistent values for global flags. On future invocations the flag can then be omitted as it is read from the config file diff --git a/client/go/internal/cli/cmd/curl.go b/client/go/internal/cli/cmd/curl.go index d605ac6948c..3d81a5d2c0e 100644 --- a/client/go/internal/cli/cmd/curl.go +++ b/client/go/internal/cli/cmd/curl.go @@ -59,6 +59,7 @@ $ vespa curl -- -v --data-urlencode "yql=select * from music where album contain if err != nil { return err } + // TODO(mpolden): Support issuing request to deploy service if useDeploy { if err := addAccessToken(c, target); err != nil { return err diff --git a/client/go/internal/cli/cmd/destroy.go b/client/go/internal/cli/cmd/destroy.go index 2c32b7406b7..f4822330e05 100644 --- a/client/go/internal/cli/cmd/destroy.go +++ b/client/go/internal/cli/cmd/destroy.go @@ -13,8 +13,8 @@ func newDestroyCmd(cli *CLI) *cobra.Command { force := false cmd := &cobra.Command{ Use: "destroy", - Short: "Remove a deployed application and its data", - Long: `Remove a deployed application and its data. + Short: "Remove a deployed Vespa application and its data", + Long: `Remove a deployed Vespa application and its data. This command removes the currently deployed application and permanently deletes its data. diff --git a/client/go/internal/cli/cmd/feed.go b/client/go/internal/cli/cmd/feed.go index 79949a02106..5cdd0d7d63b 100644 --- a/client/go/internal/cli/cmd/feed.go +++ b/client/go/internal/cli/cmd/feed.go @@ -58,8 +58,8 @@ func newFeedCmd(cli *CLI) *cobra.Command { var options feedOptions cmd := &cobra.Command{ Use: "feed json-file [json-file]...", - Short: "Feed multiple document operations to a Vespa cluster", - Long: `Feed multiple document operations to a Vespa cluster. + Short: "Feed multiple document operations to Vespa", + Long: `Feed multiple document operations to Vespa. This command can be used to feed large amounts of documents to a Vespa cluster efficiently. diff --git a/client/go/internal/cli/cmd/version.go b/client/go/internal/cli/cmd/version.go index eb2618f7274..f110541c192 100644 --- a/client/go/internal/cli/cmd/version.go +++ b/client/go/internal/cli/cmd/version.go @@ -22,7 +22,7 @@ func newVersionCmd(cli *CLI) *cobra.Command { var skipVersionCheck bool cmd := &cobra.Command{ Use: "version", - Short: "Show current version and check for updates", + Short: "Show current CLI version and check for updates", DisableAutoGenTag: true, SilenceUsage: true, Args: cobra.ExactArgs(0), diff --git a/client/go/internal/cli/cmd/visit.go b/client/go/internal/cli/cmd/visit.go index 2a63a5fb57e..bb226701e0a 100644 --- a/client/go/internal/cli/cmd/visit.go +++ b/client/go/internal/cli/cmd/visit.go @@ -90,8 +90,8 @@ func newVisitCmd(cli *CLI) *cobra.Command { ) cmd := &cobra.Command{ Use: "visit", - Short: "Visit and print all documents in a Vespa cluster", - Long: `Visit and print all documents in a Vespa cluster. + Short: "Fetch and print all documents from Vespa", + Long: `Fetch and print all documents from Vespa. By default prints each document received on its own line (JSONL format). `, -- cgit v1.2.3