Improve command descriptions

cmoog · cmoog · commit 5e43b71261f5 · 2020-07-29T13:32:00.000-05:00
diff --git a/cmd/coder/envs.go b/cmd/coder/envs.go
@@ -14,7 +14,7 @@ type envsCmd struct {
 func (cmd envsCmd) Spec() cli.CommandSpec {
 	return cli.CommandSpec{
 		Name: "envs",
-		Desc: "get a list of active environment",
+		Desc: "get a list of environments owned by the authenticated user",
 	}
 }
 
diff --git a/cmd/coder/logout.go b/cmd/coder/logout.go
@@ -17,7 +17,7 @@ type logoutCmd struct {
 func (cmd logoutCmd) Spec() cli.CommandSpec {
 	return cli.CommandSpec{
 		Name: "logout",
-		Desc: "remote local authentication credentials (if any)",
+		Desc: "remove local authentication credentials (if any)",
 	}
 }
 
diff --git a/cmd/coder/shell.go b/cmd/coder/shell.go
@@ -27,7 +27,7 @@ func (cmd *shellCmd) Spec() cli.CommandSpec {
 	return cli.CommandSpec{
 		Name:    "sh",
 		Usage:   "<env name> [<command [args...]>]",
-		Desc:    "executes a remote command on the environment\nIf no command is specified, the default shell is opened.",
+		Desc:    "execute a remote command on the environment\nIf no command is specified, the default shell is opened.",
 		RawArgs: true,
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ type envsCmd struct {`
`14`	`14`	`func (cmd envsCmd) Spec() cli.CommandSpec {`
`15`	`15`	`return cli.CommandSpec{`
`16`	`16`	`Name: "envs",`
`17`		`- Desc: "get a list of active environment",`
	`17`	`+ Desc: "get a list of environments owned by the authenticated user",`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ type logoutCmd struct {`
`17`	`17`	`func (cmd logoutCmd) Spec() cli.CommandSpec {`
`18`	`18`	`return cli.CommandSpec{`
`19`	`19`	`Name: "logout",`
`20`		`- Desc: "remote local authentication credentials (if any)",`
	`20`	`+ Desc: "remove local authentication credentials (if any)",`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ func (cmd *shellCmd) Spec() cli.CommandSpec {`
`27`	`27`	`return cli.CommandSpec{`
`28`	`28`	`Name: "sh",`
`29`	`29`	`Usage: "<env name> [<command [args...]>]",`
`30`		`- Desc: "executes a remote command on the environment\nIf no command is specified, the default shell is opened.",`
	`30`	`+ Desc: "execute a remote command on the environment\nIf no command is specified, the default shell is opened.",`
`31`	`31`	`RawArgs: true,`
`32`	`32`	`}`
`33`	`33`	`}`