Skip to content

Commit 82e658e

Browse files
committed
fix doc
1 parent a9ccd7c commit 82e658e

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

doc.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ Writing bash completion scripts is a hard work. This package provides an easy wa
55
to create bash completion scripts for any command, and also an easy way to install/uninstall
66
the completion of the command.
77
8-
## go command bash completion
8+
go command bash completion
99
1010
In [gocomplete](./cmd/gocomplete) there is an example for bash completion for the `go` command line.
1111
1212
This is an example that uses the `complete` package on the `go` command - the `complete` package
1313
can also be used to implement any completions, see [Usage](#usage).
1414
15-
### Install
15+
Install
1616
1717
1. Type in your shell:
1818
@@ -23,21 +23,22 @@ can also be used to implement any completions, see [Usage](#usage).
2323
2424
Uninstall by `gocomplete -uninstall`
2525
26-
### Features
26+
27+
Features
2728
2829
- Complete `go` command, including sub commands and all flags.
2930
- Complete packages names or `.go` files when necessary.
3031
- Complete test names after `-run` flag.
3132
32-
## complete package
33+
complete package
3334
3435
Supported shells:
3536
3637
- [x] bash
3738
- [x] zsh
3839
- [x] fish
3940
40-
### Usage
41+
Usage
4142
4243
Assuming you have program called `run` and you want to have bash completion
4344
for it, meaning, if you type `run` then space, then press the `Tab` key,
@@ -100,11 +101,10 @@ So here it is:
100101
complete.New("run", run).Run()
101102
}
102103
103-
### Self completing program
104+
Self completing program
104105
105106
In case that the program that we want to complete is written in go we
106107
can make it self completing.
107-
108108
Here is an [example](./example/self/main.go)
109109
110110
*/

0 commit comments

Comments
 (0)