summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorEyal Posener <[email protected]>2019-03-07 23:39:51 +0200
committerEyal Posener <[email protected]>2019-03-07 23:39:51 +0200
commit82e658e4f39dc2808175e6558a5315b3fa9e5e4b (patch)
tree23974c44fe5ec7fa30cee66bebaf9fd8a1984e9d /doc.go
parenta9ccd7c51443203389d418e594ef94f05cab2e56 (diff)
fix doc
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go14
1 files changed, 7 insertions, 7 deletions
diff --git a/doc.go b/doc.go
index a16a7dd..c8d0220 100644
--- a/doc.go
+++ b/doc.go
@@ -5,14 +5,14 @@ Writing bash completion scripts is a hard work. This package provides an easy wa
to create bash completion scripts for any command, and also an easy way to install/uninstall
the completion of the command.
-## go command bash completion
+go command bash completion
In [gocomplete](./cmd/gocomplete) there is an example for bash completion for the `go` command line.
This is an example that uses the `complete` package on the `go` command - the `complete` package
can also be used to implement any completions, see [Usage](#usage).
-### Install
+Install
1. Type in your shell:
@@ -23,13 +23,14 @@ can also be used to implement any completions, see [Usage](#usage).
Uninstall by `gocomplete -uninstall`
-### Features
+
+Features
- Complete `go` command, including sub commands and all flags.
- Complete packages names or `.go` files when necessary.
- Complete test names after `-run` flag.
-## complete package
+complete package
Supported shells:
@@ -37,7 +38,7 @@ Supported shells:
- [x] zsh
- [x] fish
-### Usage
+Usage
Assuming you have program called `run` and you want to have bash completion
for it, meaning, if you type `run` then space, then press the `Tab` key,
@@ -100,11 +101,10 @@ So here it is:
complete.New("run", run).Run()
}
-### Self completing program
+Self completing program
In case that the program that we want to complete is written in go we
can make it self completing.
-
Here is an [example](./example/self/main.go)
*/