Skip to content

Commit

Permalink
style: end short help with a period
Browse files Browse the repository at this point in the history
  • Loading branch information
alexeagle committed Sep 24, 2021
1 parent 6510ef8 commit b9f0e25
Show file tree
Hide file tree
Showing 11 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion cmd/aspect/build/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func NewBuildCmd(

cmd := &cobra.Command{
Use: "build",
Short: "Builds the specified targets, using the options",
Short: "Builds the specified targets, using the options.",
Long: "Invokes bazel build on the specified targets. " +
"See 'bazel help target-syntax' for details and examples on how to specify targets to build.",
RunE: b.Run,
Expand Down
2 changes: 1 addition & 1 deletion cmd/aspect/clean/clean.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func NewCleanCmd(

cmd := &cobra.Command{
Use: "clean",
Short: "Removes the output tree",
Short: "Removes the output tree.",
Long: `Removes bazel-created output, including all object files, and bazel metadata.
clean deletes the output directories for all build configurations performed by
Expand Down
2 changes: 1 addition & 1 deletion cmd/aspect/docs/docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func NewDocsCmd(streams ioutils.Streams) *cobra.Command {

cmd := &cobra.Command{
Use: "docs",
Short: "Open documentation in the browser",
Short: "Open documentation in the browser.",
Long: `Given a selected topic, open the relevant API docs in a browser window.
The mechanism of choosing the browser to open is documented at https://github.com/pkg/browser
By default, opens docs.bazel.build`,
Expand Down
2 changes: 1 addition & 1 deletion cmd/aspect/info/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ func NewInfoCmd(streams ioutils.Streams) *cobra.Command {

cmd := &cobra.Command{
Use: "info",
Short: "Displays runtime info about the bazel server",
Short: "Displays runtime info about the bazel server.",
Long: `Displays information about the state of the bazel process in the
form of several "key: value" pairs. This includes the locations of
several output directories. Because some of the
Expand Down
2 changes: 1 addition & 1 deletion cmd/aspect/version/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func NewVersionCmd(streams ioutils.Streams) *cobra.Command {

cmd := &cobra.Command{
Use: "version",
Short: "Print the version of aspect CLI as well as tools it invokes",
Short: "Print the version of aspect CLI as well as tools it invokes.",
Long: `Prints version info on colon-separated lines, just like bazel does`,
RunE: v.Run,
}
Expand Down
10 changes: 5 additions & 5 deletions docs/aspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ Aspect CLI is a better frontend for running bazel

### SEE ALSO

* [aspect build](aspect_build.md) - Builds the specified targets, using the options
* [aspect clean](aspect_clean.md) - Removes the output tree
* [aspect docs](aspect_docs.md) - Open documentation in the browser
* [aspect info](aspect_info.md) - Displays runtime info about the bazel server
* [aspect version](aspect_version.md) - Print the version of aspect CLI as well as tools it invokes
* [aspect build](aspect_build.md) - Builds the specified targets, using the options.
* [aspect clean](aspect_clean.md) - Removes the output tree.
* [aspect docs](aspect_docs.md) - Open documentation in the browser.
* [aspect info](aspect_info.md) - Displays runtime info about the bazel server.
* [aspect version](aspect_version.md) - Print the version of aspect CLI as well as tools it invokes.

###### Auto generated by spf13/cobra
2 changes: 1 addition & 1 deletion docs/aspect_build.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## aspect build

Builds the specified targets, using the options
Builds the specified targets, using the options.

### Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/aspect_clean.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## aspect clean

Removes the output tree
Removes the output tree.

### Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/aspect_docs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## aspect docs

Open documentation in the browser
Open documentation in the browser.

### Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/aspect_info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## aspect info

Displays runtime info about the bazel server
Displays runtime info about the bazel server.

### Synopsis

Expand Down
2 changes: 1 addition & 1 deletion docs/aspect_version.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## aspect version

Print the version of aspect CLI as well as tools it invokes
Print the version of aspect CLI as well as tools it invokes.

### Synopsis

Expand Down

0 comments on commit b9f0e25

Please sign in to comment.