Rationalise style of help strings (#289)

cmd/duffle/build.go

@@ -27,7 +27,7 @@ import (
 )
 
 const buildDesc = `
-This command builds a CNAB bundle.
+Builds a CNAB bundle.
 `
 
 const (
@@ -59,7 +59,7 @@ func newBuildCmd(out io.Writer) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "build [path]",
-		Short: "builds a CNAB bundle",
+		Short: "build a CNAB bundle",
 		Long:  buildDesc,
 		PersistentPreRun: func(c *cobra.Command, args []string) {
 			build.dockerClientOptions.Common.SetDefaultOptions(f)

cmd/duffle/credentials.go

@@ -7,7 +7,7 @@ import (
 )
 
 const credentialDesc = `
-Manage credential sets
+Manages credential sets.
 `
 
 func newCredentialsCmd(w io.Writer) *cobra.Command {

cmd/duffle/init.go

@@ -45,7 +45,7 @@ func newInitCmd(w io.Writer) *cobra.Command {
 
 	cmd := &cobra.Command{
 		Use:   "init",
-		Short: "sets up local environment to work with duffle",
+		Short: "set up local environment to work with duffle",
 		Long:  initDesc,
 		Args:  cobra.ExactArgs(0),
 		RunE: func(cmd *cobra.Command, args []string) error {

cmd/duffle/install.go

@@ -22,7 +22,7 @@ import (
 )
 
 func newInstallCmd() *cobra.Command {
-	const usage = `Install a CNAB bundle
+	const usage = `Installs a CNAB bundle.
 
 This installs a CNAB bundle with a specific installation name. Once the install is complete,
 this bundle can be referenced by installation name.

cmd/duffle/key.go

@@ -7,7 +7,7 @@ import (
 )
 
 const keyDesc = `
-Manage OpenPGP keys, signatures, and attestations.
+Manages OpenPGP keys, signatures, and attestations.
 `
 
 // TODO

cmd/duffle/pull.go

@@ -8,17 +8,15 @@ import (
 )
 
 func newPullCmd(w io.Writer) *cobra.Command {
-	const usage = `pulls a CNAB bundle from a repository
-
-This command pulls a CNAB bundle into the cache without installing it.
+	const usage = `Pulls a CNAB bundle into the cache without installing it.
 
 Example:
 	$ duffle pull duffle/example:0.1.0
 `
 
 	cmd := &cobra.Command{
 		Use:   "pull",
-		Short: "pulls a CNAB bundle from a repository",
+		Short: "pull a CNAB bundle from a repository",
 		Long:  usage,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			path, err := getBundleFile(args[0])

cmd/duffle/push.go

@@ -19,13 +19,13 @@ type pushCmd struct {
 }
 
 func newPushCmd(out io.Writer) *cobra.Command {
-	const usage = `pushes a CNAB bundle to a repository`
+	const usage = `Pushes a CNAB bundle to a repository.`
 
 	var push = &pushCmd{out: out}
 
 	cmd := &cobra.Command{
 		Use:   "push",
-		Short: usage,
+		Short: "push a CNAB bundle to a repository",
 		Long:  usage,
 		RunE: func(_ *cobra.Command, args []string) error {
 			push.home = home.Home(homePath())

cmd/duffle/status.go

@@ -14,7 +14,7 @@ import (
 
 func newStatusCmd(w io.Writer) *cobra.Command {
 	const short = "get the status of an installation"
-	const long = `Get the status of an existing installation.
+	const long = `Gets the status of an existing installation.
 
 Given an installation name, execute the status task for this. A status
 action will restart the CNAB image and ask it to query for status. For that

cmd/duffle/uninstall.go

@@ -9,7 +9,7 @@ import (
 	"github.com/deis/duffle/pkg/action"
 )
 
-const usage = `This command will uninstall an installation of a CNAB bundle.
+const usage = `Uninstalls an installation of a CNAB bundle.
 
 When using '--parameters' or '--set', the uninstall command will replace the old
 parameters with the new ones supplied (even if the new set is an empty set). If neither

cmd/duffle/upgrade.go

@@ -9,8 +9,8 @@ import (
 	"github.com/deis/duffle/pkg/action"
 )
 
-const upgradeUsage = `This command will perform the upgrade action in the CNAB bundle`
-const upgradeLong = `Upgrade an existing application.
+const upgradeUsage = `perform the upgrade action in the CNAB bundle`
+const upgradeLong = `Upgrades an existing application.
 
 An upgrade can do the following:
 

cmd/duffle/version.go

@@ -10,7 +10,7 @@ import (
 )
 
 func newVersionCmd(w io.Writer) *cobra.Command {
-	const usage = `prints current version of the Duffle CLI`
+	const usage = `print current version of the Duffle CLI`
 
 	cmd := &cobra.Command{
 		Use:   "version",