summaryrefslogtreecommitdiff
path: root/doc.go
diff options
context:
space:
mode:
authorEyal Posener <[email protected]>2019-03-08 09:25:01 +0200
committerEyal Posener <[email protected]>2019-03-08 09:44:51 +0200
commiteb60014a10af1ad2391fc7a526295c41ea98b758 (patch)
tree3a610642de2a3d7ec2fb395dcd6ffec8f5b052fc /doc.go
parent82e658e4f39dc2808175e6558a5315b3fa9e5e4b (diff)
fix doc
Diffstat (limited to 'doc.go')
-rw-r--r--doc.go11
1 files changed, 5 insertions, 6 deletions
diff --git a/doc.go b/doc.go
index c8d0220..0ae09a1 100644
--- a/doc.go
+++ b/doc.go
@@ -5,12 +5,12 @@ 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.
+In ./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).
+can also be used to implement any completions, see #usage.
Install
@@ -23,14 +23,13 @@ Install
Uninstall by `gocomplete -uninstall`
-
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:
@@ -105,7 +104,7 @@ 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)
+Here is an example: ./example/self/main.go .
*/
package complete