wit
/
arg
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix example

This commit is contained in:
Alex Flint 2015-11-01 11:40:09 -08:00
parent beede9329a
commit cd9f5188a8
2 changed files with 15 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
example/example.go
View File

@ -1,14 +0,0 @@
package main
import "github.com/alexflint/go-arg"
func main() {
var args struct {
Input string `arg:"positional"`
Output []string `arg:"positional"`
Verbose bool `arg:"-v,help:verbosity level"`
Dataset string `arg:"help:dataset to use"`
Optimize int `arg:"-O,help:optimization level"`
}
arg.MustParse(&args)
}

30
parse.go
View File

@ -1,17 +1,17 @@
// Package arg parses command line arguments using the fields from a struct. // Package arg parses command line arguments using the fields from a struct.
// Any exported field is interpreted as a command line option, so // Any exported field is interpreted as a command line option, so
// //
// var args struct { // var args struct {
// Iter int // Iter int
// Debug bool // Debug bool
// } // }
// arg.MustParse(&args) // arg.MustParse(&args)
// //
// defines two command line arguments, which can be set using any of // defines two command line arguments, which can be set using any of
// //
// ./example --iter=1 --bar // bar is a boolean flag so its value is optional // ./example --iter=1 --bar // bar is a boolean flag so its value is optional
// ./example -iter 1 // bar will default to its zero value // ./example -iter 1 // bar will default to its zero value
// ./example --bar=true // foo will default to its zero value // ./example --bar=true // foo will default to its zero value
// //
// The fastest way to learn how to use go-arg is to read the examples below. // The fastest way to learn how to use go-arg is to read the examples below.
// //
@ -20,13 +20,13 @@
// //
// Tags can be specified using the `arg` package name: // Tags can be specified using the `arg` package name:
// //
// var args struct { // var args struct {
// Input string `arg:"positional"` // Input string `arg:"positional"`
// Log string `arg:"positional,required"` // Log string `arg:"positional,required"`
// Debug bool `arg:"-d,help:turn on debug mode"` // Debug bool `arg:"-d,help:turn on debug mode"`
// RealMode bool `arg:"--real" // RealMode bool `arg:"--real"
// Wr io.Writer `arg:"-"` // Wr io.Writer `arg:"-"`
// } // }
// //
// The valid tag strings are `positional`, `required`, and `help`. Further, any tag string // The valid tag strings are `positional`, `required`, and `help`. Further, any tag string
// that starts with a single hyphen is the short form for an argument (e.g. `./example -d`), // that starts with a single hyphen is the short form for an argument (e.g. `./example -d`),