diff options
author | Martin Polden <mpolden@mpolden.no> | 2023-06-19 13:17:56 +0200 |
---|---|---|
committer | Martin Polden <mpolden@mpolden.no> | 2023-06-19 13:18:56 +0200 |
commit | e0ddec70af0d06c80958b2a62669a2ddc1396394 (patch) | |
tree | ee7e0524114d0b769ee7ede4dd0a1c8fca8d7b96 | |
parent | 8f27c438f6ce07ee13fddc288bcebbad8b0bd815 (diff) |
Tweak descriptions
-rw-r--r-- | client/go/internal/cli/cmd/document.go | 4 | ||||
-rw-r--r-- | client/go/internal/cli/cmd/feed.go | 4 | ||||
-rw-r--r-- | client/go/internal/cli/cmd/root.go | 3 | ||||
-rw-r--r-- | client/go/internal/cli/cmd/visit.go | 6 |
4 files changed, 8 insertions, 9 deletions
diff --git a/client/go/internal/cli/cmd/document.go b/client/go/internal/cli/cmd/document.go index 0ed68e30ced..6a07121a13b 100644 --- a/client/go/internal/cli/cmd/document.go +++ b/client/go/internal/cli/cmd/document.go @@ -160,8 +160,8 @@ func newDocumentCmd(cli *CLI) *cobra.Command { ) cmd := &cobra.Command{ Use: "document json-file", - Short: "Issue a document operation to Vespa", - Long: `Issue a document operation to Vespa. + Short: "Issue a single document operation to Vespa", + Long: `Issue a single document operation to Vespa. The operation must be on the format documented in https://docs.vespa.ai/en/reference/document-json-format.html#document-operations diff --git a/client/go/internal/cli/cmd/feed.go b/client/go/internal/cli/cmd/feed.go index 6d368cb210b..8c502d0409f 100644 --- a/client/go/internal/cli/cmd/feed.go +++ b/client/go/internal/cli/cmd/feed.go @@ -56,8 +56,8 @@ func newFeedCmd(cli *CLI) *cobra.Command { var options feedOptions cmd := &cobra.Command{ Use: "feed FILE [FILE]...", - Short: "Feed documents to a Vespa cluster", - Long: `Feed documents to a Vespa cluster. + Short: "Feed multiple documents to a Vespa cluster", + Long: `Feed multiple documents to a Vespa cluster. This command can be used to feed large amounts of documents to a Vespa cluster efficiently. diff --git a/client/go/internal/cli/cmd/root.go b/client/go/internal/cli/cmd/root.go index 89184e7a7fa..41de0bfc9d3 100644 --- a/client/go/internal/cli/cmd/root.go +++ b/client/go/internal/cli/cmd/root.go @@ -105,8 +105,7 @@ func New(stdout, stderr io.Writer, environment []string) (*CLI, error) { Short: "The command-line tool for Vespa.ai", Long: `The command-line tool for Vespa.ai. -Use it on Vespa instances running locally, remotely or in the cloud. -Prefer web service API's to this in production. +Use it on Vespa instances running locally, remotely or in Vespa Cloud. Vespa documentation: https://docs.vespa.ai diff --git a/client/go/internal/cli/cmd/visit.go b/client/go/internal/cli/cmd/visit.go index 1875c768c60..a588474bd2b 100644 --- a/client/go/internal/cli/cmd/visit.go +++ b/client/go/internal/cli/cmd/visit.go @@ -89,10 +89,10 @@ func newVisitCmd(cli *CLI) *cobra.Command { ) cmd := &cobra.Command{ Use: "visit", - Short: "Visit and print all documents in a vespa cluster", - Long: `Run visiting to retrieve all documents. + Short: "Visit and print all documents in a Vespa cluster", + Long: `Visit and print all documents in a Vespa cluster. -By default prints each document received on its own line (JSON-L format). +By default prints each document received on its own line (JSONL format). `, Example: `$ vespa visit # get documents from any cluster $ vespa visit --content-cluster search # get documents from cluster named "search" |