Skip to content

Commit 2fd5f71

Browse files
MichaelMureMichaelMure
committed
commands: add a "." at the end of Short commands usage
1 parent 304a334 commit 2fd5f71

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+197
-145
lines changed

Diff for: ‎commands/add.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func runAddBug(cmd *cobra.Command, args []string) error {
5656

5757
var addCmd = &cobra.Command{
5858
Use: "add",
59-
Short: "Create a new bug",
59+
Short: "Create a new bug.",
6060
PreRunE: loadRepo,
6161
RunE: runAddBug,
6262
}

Diff for: ‎commands/bridge.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func runBridge(cmd *cobra.Command, args []string) error {
3131

3232
var bridgeCmd = &cobra.Command{
3333
Use: "bridge",
34-
Short: "Configure and use bridges to other bug trackers",
34+
Short: "Configure and use bridges to other bug trackers.",
3535
PreRunE: loadRepo,
3636
RunE: runBridge,
3737
Args: cobra.NoArgs,

Diff for: ‎commands/bridge_configure.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ func promptName() (string, error) {
9191

9292
var bridgeConfigureCmd = &cobra.Command{
9393
Use: "configure",
94-
Short: "Configure a new bridge",
94+
Short: "Configure a new bridge.",
9595
PreRunE: loadRepo,
9696
RunE: runBridgeConfigure,
9797
}

Diff for: ‎commands/bridge_pull.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func runBridgePull(cmd *cobra.Command, args []string) error {
3838

3939
var bridgePullCmd = &cobra.Command{
4040
Use: "pull [<name>]",
41-
Short: "Pull updates",
41+
Short: "Pull updates.",
4242
PreRunE: loadRepo,
4343
RunE: runBridgePull,
4444
}

Diff for: ‎commands/bridge_rm.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func runBridgeRm(cmd *cobra.Command, args []string) error {
2525

2626
var bridgeRmCmd = &cobra.Command{
2727
Use: "rm name <name>",
28-
Short: "Delete a configured bridge",
28+
Short: "Delete a configured bridge.",
2929
PreRunE: loadRepo,
3030
RunE: runBridgeRm,
3131
Args: cobra.ExactArgs(1),

Diff for: ‎commands/commands.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func runCommands(cmd *cobra.Command, args []string) error {
6161

6262
var commandsCmd = &cobra.Command{
6363
Use: "commands [<option>...]",
64-
Short: "Display available commands",
64+
Short: "Display available commands.",
6565
RunE: runCommands,
6666
}
6767

Diff for: ‎commands/comment.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ func commentsTextOutput(comments []bug.Comment) {
4646

4747
var commentCmd = &cobra.Command{
4848
Use: "comment [<id>]",
49-
Short: "Display or add comments",
49+
Short: "Display or add comments.",
5050
PreRunE: loadRepo,
5151
RunE: runComment,
5252
}

Diff for: ‎commands/comment_add.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func runCommentAdd(cmd *cobra.Command, args []string) error {
5656

5757
var commentAddCmd = &cobra.Command{
5858
Use: "add [<id>]",
59-
Short: "Add a new comment",
59+
Short: "Add a new comment.",
6060
PreRunE: loadRepo,
6161
RunE: runCommentAdd,
6262
}

Diff for: ‎commands/deselect.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ func runDeselect(cmd *cobra.Command, args []string) error {
2525

2626
var deselectCmd = &cobra.Command{
2727
Use: "deselect",
28-
Short: "Clear the implicitly selected bug",
28+
Short: "Clear the implicitly selected bug.",
2929
Example: `git bug select 2f15
3030
git bug comment
3131
git bug status

Diff for: ‎commands/label.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func runLabel(cmd *cobra.Command, args []string) error {
3333

3434
var labelCmd = &cobra.Command{
3535
Use: "label [<id>]",
36-
Short: "Display, add or remove labels",
36+
Short: "Display, add or remove labels.",
3737
PreRunE: loadRepo,
3838
RunE: runLabel,
3939
}

Diff for: ‎commands/label_add.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func runLabelAdd(cmd *cobra.Command, args []string) error {
3737

3838
var labelAddCmd = &cobra.Command{
3939
Use: "add [<id>] <label>[...]",
40-
Short: "Add a label",
40+
Short: "Add a label.",
4141
PreRunE: loadRepo,
4242
RunE: runLabelAdd,
4343
}

Diff for: ‎commands/label_rm.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func runLabelRm(cmd *cobra.Command, args []string) error {
3737

3838
var labelRmCmd = &cobra.Command{
3939
Use: "rm [<id>] <label>[...]",
40-
Short: "Remove a label",
40+
Short: "Remove a label.",
4141
PreRunE: loadRepo,
4242
RunE: runLabelRm,
4343
}

Diff for: ‎commands/ls-labels.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ func runLsLabel(cmd *cobra.Command, args []string) error {
2727

2828
var lsLabelCmd = &cobra.Command{
2929
Use: "ls-label",
30-
Short: "List valid labels",
30+
Short: "List valid labels.",
3131
Long: `List valid labels.
3232
3333
Note: in the future, a proper label policy could be implemented where valid labels are defined in a configuration file. Until that, the default behavior is to return the list of labels already used.`,

Diff for: ‎commands/ls.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ func lsQueryFromFlags() (*cache.Query, error) {
131131

132132
var lsCmd = &cobra.Command{
133133
Use: "ls [<query>]",
134-
Short: "List bugs",
134+
Short: "List bugs.",
135135
Long: `Display a summary of each bugs.
136136
137137
You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language or with flags.`,

Diff for: ‎commands/pull.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func runPull(cmd *cobra.Command, args []string) error {
5454
// showCmd defines the "push" subcommand.
5555
var pullCmd = &cobra.Command{
5656
Use: "pull [<remote>]",
57-
Short: "Pull bugs update from a git remote",
57+
Short: "Pull bugs update from a git remote.",
5858
PreRunE: loadRepo,
5959
RunE: runPull,
6060
}

Diff for: ‎commands/push.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ func runPush(cmd *cobra.Command, args []string) error {
3939
// showCmd defines the "push" subcommand.
4040
var pushCmd = &cobra.Command{
4141
Use: "push [<remote>]",
42-
Short: "Push bugs update to a git remote",
42+
Short: "Push bugs update to a git remote.",
4343
PreRunE: loadRepo,
4444
RunE: runPush,
4545
}

Diff for: ‎commands/root.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ var repo repository.ClockedRepo
1919
// RootCmd represents the base command when called without any subcommands
2020
var RootCmd = &cobra.Command{
2121
Use: rootCommandName,
22-
Short: "A bug tracker embedded in Git",
22+
Short: "A bug tracker embedded in Git.",
2323
Long: `git-bug is a bug tracker embedded in git.
2424
2525
git-bug use git objects to store the bug tracking separated from the files

Diff for: ‎commands/select.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func runSelect(cmd *cobra.Command, args []string) error {
4141

4242
var selectCmd = &cobra.Command{
4343
Use: "select <id>",
44-
Short: "Select a bug for implicit use in future commands",
44+
Short: "Select a bug for implicit use in future commands.",
4545
Example: `git bug select 2f15
4646
git bug comment
4747
git bug status

Diff for: ‎commands/show.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func runShowBug(cmd *cobra.Command, args []string) error {
113113

114114
var showCmd = &cobra.Command{
115115
Use: "show [<id>]",
116-
Short: "Display the details of a bug",
116+
Short: "Display the details of a bug.",
117117
PreRunE: loadRepo,
118118
RunE: runShowBug,
119119
}

Diff for: ‎commands/status.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func runStatus(cmd *cobra.Command, args []string) error {
3131

3232
var statusCmd = &cobra.Command{
3333
Use: "status [<id>]",
34-
Short: "Display or change a bug status",
34+
Short: "Display or change a bug status.",
3535
PreRunE: loadRepo,
3636
RunE: runStatus,
3737
}

Diff for: ‎commands/status_close.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func runStatusClose(cmd *cobra.Command, args []string) error {
3030

3131
var closeCmd = &cobra.Command{
3232
Use: "close [<id>]",
33-
Short: "Mark a bug as closed",
33+
Short: "Mark a bug as closed.",
3434
PreRunE: loadRepo,
3535
RunE: runStatusClose,
3636
}

Diff for: ‎commands/status_open.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func runStatusOpen(cmd *cobra.Command, args []string) error {
3030

3131
var openCmd = &cobra.Command{
3232
Use: "open [<id>]",
33-
Short: "Mark a bug as open",
33+
Short: "Mark a bug as open.",
3434
PreRunE: loadRepo,
3535
RunE: runStatusOpen,
3636
}

Diff for: ‎commands/termui.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func runTermUI(cmd *cobra.Command, args []string) error {
2020

2121
var termUICmd = &cobra.Command{
2222
Use: "termui",
23-
Short: "Launch the terminal UI",
23+
Short: "Launch the terminal UI.",
2424
PreRunE: loadRepoEnsureUser,
2525
RunE: runTermUI,
2626
}

Diff for: ‎commands/title.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func runTitle(cmd *cobra.Command, args []string) error {
3131

3232
var titleCmd = &cobra.Command{
3333
Use: "title [<id>]",
34-
Short: "Display or change a title",
34+
Short: "Display or change a title.",
3535
PreRunE: loadRepo,
3636
RunE: runTitle,
3737
}

Diff for: ‎commands/title_edit.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ func runTitleEdit(cmd *cobra.Command, args []string) error {
5454

5555
var titleEditCmd = &cobra.Command{
5656
Use: "edit [<id>]",
57-
Short: "Edit a title",
57+
Short: "Edit a title.",
5858
PreRunE: loadRepo,
5959
RunE: runTitleEdit,
6060
}

Diff for: ‎commands/user.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func runUser(cmd *cobra.Command, args []string) error {
4343

4444
var userCmd = &cobra.Command{
4545
Use: "user [<id>]",
46-
Short: "Display or change the user identity",
46+
Short: "Display or change the user identity.",
4747
PreRunE: loadRepo,
4848
RunE: runUser,
4949
}

Diff for: ‎commands/user_create.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ func runUserCreate(cmd *cobra.Command, args []string) error {
7070

7171
var userCreateCmd = &cobra.Command{
7272
Use: "create",
73-
Short: "Create a new identity",
73+
Short: "Create a new identity.",
7474
PreRunE: loadRepo,
7575
RunE: runUserCreate,
7676
}

Diff for: ‎commands/user_list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func runUserLs(cmd *cobra.Command, args []string) error {
3333

3434
var userLsCmd = &cobra.Command{
3535
Use: "ls",
36-
Short: "List identities",
36+
Short: "List identities.",
3737
PreRunE: loadRepo,
3838
RunE: runUserLs,
3939
}

Diff for: ‎commands/version.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func runVersionCmd(cmd *cobra.Command, args []string) {
4141

4242
var versionCmd = &cobra.Command{
4343
Use: "version",
44-
Short: "Show git-bug version information",
44+
Short: "Show git-bug version information.",
4545
Run: runVersionCmd,
4646
}
4747

Diff for: ‎commands/webui.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ func (gufh *gitUploadFileHandler) ServeHTTP(rw http.ResponseWriter, r *http.Requ
224224

225225
var webUICmd = &cobra.Command{
226226
Use: "webui",
227-
Short: "Launch the web UI",
227+
Short: "Launch the web UI.",
228228
PreRunE: loadRepo,
229229
RunE: runWebUI,
230230
}

Diff for: ‎doc/man/git-bug-ls-id.1

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.TH "GIT-BUG" "1" "Mar 2019" "Generated from git-bug's source code" ""
2+
.nh
3+
.ad l
4+
5+
6+
.SH NAME
7+
.PP
8+
git\-bug\-ls\-id \- List Bug Id
9+
10+
11+
.SH SYNOPSIS
12+
.PP
13+
\fBgit\-bug ls\-id [<prefix>] [flags]\fP
14+
15+
16+
.SH DESCRIPTION
17+
.PP
18+
List Bug Id
19+
20+
21+
.SH OPTIONS
22+
.PP
23+
\fB\-h\fP, \fB\-\-help\fP[=false]
24+
help for ls\-id
25+
26+
27+
.SH SEE ALSO
28+
.PP
29+
\fBgit\-bug(1)\fP

Diff for: ‎doc/md/git-bug.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## git-bug
22

3-
A bug tracker embedded in Git
3+
A bug tracker embedded in Git.
44

55
### Synopsis
66

@@ -24,23 +24,23 @@ git-bug [flags]
2424

2525
### SEE ALSO
2626

27-
* [git-bug add](git-bug_add.md) - Create a new bug
28-
* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers
29-
* [git-bug commands](git-bug_commands.md) - Display available commands
30-
* [git-bug comment](git-bug_comment.md) - Display or add comments
31-
* [git-bug deselect](git-bug_deselect.md) - Clear the implicitly selected bug
32-
* [git-bug label](git-bug_label.md) - Display, add or remove labels
33-
* [git-bug ls](git-bug_ls.md) - List bugs
27+
* [git-bug add](git-bug_add.md) - Create a new bug.
28+
* [git-bug bridge](git-bug_bridge.md) - Configure and use bridges to other bug trackers.
29+
* [git-bug commands](git-bug_commands.md) - Display available commands.
30+
* [git-bug comment](git-bug_comment.md) - Display or add comments.
31+
* [git-bug deselect](git-bug_deselect.md) - Clear the implicitly selected bug.
32+
* [git-bug label](git-bug_label.md) - Display, add or remove labels.
33+
* [git-bug ls](git-bug_ls.md) - List bugs.
3434
* [git-bug ls-id](git-bug_ls-id.md) - List Bug Id
35-
* [git-bug ls-label](git-bug_ls-label.md) - List valid labels
36-
* [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote
37-
* [git-bug push](git-bug_push.md) - Push bugs update to a git remote
38-
* [git-bug select](git-bug_select.md) - Select a bug for implicit use in future commands
39-
* [git-bug show](git-bug_show.md) - Display the details of a bug
40-
* [git-bug status](git-bug_status.md) - Display or change a bug status
41-
* [git-bug termui](git-bug_termui.md) - Launch the terminal UI
42-
* [git-bug title](git-bug_title.md) - Display or change a title
43-
* [git-bug user](git-bug_user.md) - Display or change the user identity
44-
* [git-bug version](git-bug_version.md) - Show git-bug version information
45-
* [git-bug webui](git-bug_webui.md) - Launch the web UI
35+
* [git-bug ls-label](git-bug_ls-label.md) - List valid labels.
36+
* [git-bug pull](git-bug_pull.md) - Pull bugs update from a git remote.
37+
* [git-bug push](git-bug_push.md) - Push bugs update to a git remote.
38+
* [git-bug select](git-bug_select.md) - Select a bug for implicit use in future commands.
39+
* [git-bug show](git-bug_show.md) - Display the details of a bug.
40+
* [git-bug status](git-bug_status.md) - Display or change a bug status.
41+
* [git-bug termui](git-bug_termui.md) - Launch the terminal UI.
42+
* [git-bug title](git-bug_title.md) - Display or change a title.
43+
* [git-bug user](git-bug_user.md) - Display or change the user identity.
44+
* [git-bug version](git-bug_version.md) - Show git-bug version information.
45+
* [git-bug webui](git-bug_webui.md) - Launch the web UI.
4646

Diff for: ‎doc/md/git-bug_add.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## git-bug add
22

3-
Create a new bug
3+
Create a new bug.
44

55
### Synopsis
66

7-
Create a new bug
7+
Create a new bug.
88

99
```
1010
git-bug add [flags]
@@ -21,5 +21,5 @@ git-bug add [flags]
2121

2222
### SEE ALSO
2323

24-
* [git-bug](git-bug.md) - A bug tracker embedded in Git
24+
* [git-bug](git-bug.md) - A bug tracker embedded in Git.
2525

Diff for: ‎doc/md/git-bug_bridge.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## git-bug bridge
22

3-
Configure and use bridges to other bug trackers
3+
Configure and use bridges to other bug trackers.
44

55
### Synopsis
66

7-
Configure and use bridges to other bug trackers
7+
Configure and use bridges to other bug trackers.
88

99
```
1010
git-bug bridge [flags]
@@ -18,8 +18,8 @@ git-bug bridge [flags]
1818

1919
### SEE ALSO
2020

21-
* [git-bug](git-bug.md) - A bug tracker embedded in Git
22-
* [git-bug bridge configure](git-bug_bridge_configure.md) - Configure a new bridge
23-
* [git-bug bridge pull](git-bug_bridge_pull.md) - Pull updates
24-
* [git-bug bridge rm](git-bug_bridge_rm.md) - Delete a configured bridge
21+
* [git-bug](git-bug.md) - A bug tracker embedded in Git.
22+
* [git-bug bridge configure](git-bug_bridge_configure.md) - Configure a new bridge.
23+
* [git-bug bridge pull](git-bug_bridge_pull.md) - Pull updates.
24+
* [git-bug bridge rm](git-bug_bridge_rm.md) - Delete a configured bridge.
2525

0 commit comments

Comments
 (0)