Merge pull request #15 from posener/doc

Add doc to Args
This commit is contained in:
Eyal Posener 2017-05-12 15:26:01 +03:00 committed by GitHub
commit 136e52e074
1 changed files with 10 additions and 0 deletions

10
args.go
View File

@ -2,9 +2,19 @@ package complete
// Args describes command line arguments
type Args struct {
// All lists of all arguments in command line (not including the command itself)
All []string
// Completed lists of all completed arguments in command line,
// If the last one is still being typed - no space after it,
// it won't appear in this list of arguments.
Completed []string
// Last argument in command line, the one being typed, if the last
// character in the command line is a space, this argument will be empty,
// otherwise this would be the last word.
Last string
// LastCompleted is the last argument that was fully typed.
// If the last character in the command line is space, this would be the
// last word, otherwise, it would be the word before that.
LastCompleted string
}