summaryrefslogtreecommitdiff
path: root/parse.go
diff options
context:
space:
mode:
Diffstat (limited to 'parse.go')
-rw-r--r--parse.go5
1 files changed, 3 insertions, 2 deletions
diff --git a/parse.go b/parse.go
index f8e8cf4..f9c4e62 100644
--- a/parse.go
+++ b/parse.go
@@ -1,5 +1,6 @@
// Package arg parses command line arguments using the fields from a struct.
-// Any exported field is interpreted as a command line option, so
+//
+// For example,
//
// var args struct {
// Iter int
@@ -9,7 +10,7 @@
//
// 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 set to true
// ./example -iter 1 // bar will default to its zero value
// ./example --bar=true // foo will default to its zero value
//