Merge pull request #61 from zimmski/undocumented-fields
Some field tags are undocumented
diff --git a/README.md b/README.md
index 4194e2c..0e31cb1 100644
--- a/README.md
+++ b/README.md
@@ -28,7 +28,7 @@
The flags package uses structs, reflection and struct field tags
to allow users to specify command line options. This results in very simple
-and consise specification of your application options. For example:
+and concise specification of your application options. For example:
type Options struct {
Verbose []bool `short:"v" long:"verbose" description:"Show verbose debug information"`
diff --git a/command.go b/command.go
index b55597f..47a7e4d 100644
--- a/command.go
+++ b/command.go
@@ -61,7 +61,7 @@
func (c *Command) AddGroup(shortDescription string, longDescription string, data interface{}) (*Group, error) {
group := newGroup(shortDescription, longDescription, data)
- if err := group.scanType(c.scanSubCommandHandler(group)); err != nil {
+ if err := group.scanType(c.scanSubcommandHandler(group)); err != nil {
return nil, err
}
diff --git a/command_private.go b/command_private.go
index feb41c2..83c04b0 100644
--- a/command_private.go
+++ b/command_private.go
@@ -22,7 +22,7 @@
}
}
-func (c *Command) scanSubCommandHandler(parentg *Group) scanHandler {
+func (c *Command) scanSubcommandHandler(parentg *Group) scanHandler {
f := func(realval reflect.Value, sfield *reflect.StructField) (bool, error) {
mtag := newMultiTag(string(sfield.Tag))
@@ -59,7 +59,7 @@
}
func (c *Command) scan() error {
- return c.scanType(c.scanSubCommandHandler(c.Group))
+ return c.scanType(c.scanSubcommandHandler(c.Group))
}
func (c *Command) eachCommand(f func(*Command), recurse bool) {
diff --git a/error.go b/error.go
index 40f31ae..41c251c 100644
--- a/error.go
+++ b/error.go
@@ -23,7 +23,7 @@
// ErrMarshal indicates a marshalling error while converting values.
ErrMarshal
- // ErrHelp indicates that the builtin help was shown (the error
+ // ErrHelp indicates that the built-in help was shown (the error
// contains the help message).
ErrHelp
diff --git a/flags.go b/flags.go
index 99f01e5..fb0d1fd 100644
--- a/flags.go
+++ b/flags.go
@@ -3,7 +3,7 @@
// license that can be found in the LICENSE file.
// Package flags provides an extensive command line option parser.
-// The flags package is similar in functionality to the go builtin flag package
+// The flags package is similar in functionality to the go built-in flag package
// but provides more options and uses reflection to provide a convenient and
// succinct way of specifying command line options.
//
@@ -31,7 +31,7 @@
//
// The flags package uses structs, reflection and struct field tags
// to allow users to specify command line options. This results in very simple
-// and consise specification of your application options. For example:
+// and concise specification of your application options. For example:
//
// type Options struct {
// Verbose []bool `short:"v" long:"verbose" description:"Show verbose debug information"`
@@ -106,7 +106,7 @@
// Option groups:
//
// Option groups are a simple way to semantically separate your options. The
-// only real difference is in how your options will appear in the builtin
+// only real difference is in how your options will appear in the built-in
// generated help. All options in a particular group are shown together in the
// help under the name of the group.
//
@@ -114,7 +114,7 @@
//
// 1. Use NewNamedParser specifying the various option groups.
// 2. Use AddGroup to add a group to an existing parser.
-// 3. Add a struct field to the toplevel options annotated with the
+// 3. Add a struct field to the top-level options annotated with the
// group:"group-name" tag.
//
//
@@ -127,7 +127,7 @@
// commands. Using commands you can easily separate multiple functions of your
// application.
//
-// There are currently two ways to specifiy a command.
+// There are currently two ways to specify a command.
//
// 1. Use AddCommand on an existing parser.
// 2. Add a struct field to your options struct annotated with the
@@ -145,7 +145,7 @@
// Command structs can have options which become valid to parse after the
// command has been specified on the command line. It is currently not valid
// to specify options from the parent level of the command after the command
-// name has occurred. Thus, given a toplevel option "-v" and a command "add":
+// name has occurred. Thus, given a top-level option "-v" and a command "add":
//
// Valid: ./app -v add
// Invalid: ./app add -v
diff --git a/group.go b/group.go
index a251a56..a2b368d 100644
--- a/group.go
+++ b/group.go
@@ -20,13 +20,13 @@
// and for you, since groups can be nested.
type Group struct {
// A short description of the group. The
- // short description is primarily used in the builtin generated help
+ // short description is primarily used in the built-in generated help
// message
ShortDescription string
// A long description of the group. The long
// description is primarily used to present information on commands
- // (Command embeds Group) in the builtin generated help and man pages.
+ // (Command embeds Group) in the built-in generated help and man pages.
LongDescription string
// All the options in the group
@@ -35,7 +35,7 @@
// All the subgroups
groups []*Group
- // Whether the group represents the builtin help group
+ // Whether the group represents the built-in help group
isBuiltinHelp bool
data interface{}
diff --git a/help.go b/help.go
index cc4d554..f708a1f 100644
--- a/help.go
+++ b/help.go
@@ -280,7 +280,7 @@
p.eachActiveGroup(func(c *Command, grp *Group) {
first := true
- // Skip builtin help group for all commands except the toplevel
+ // Skip built-in help group for all commands except the top-level
// parser
if grp.isBuiltinHelp && c != p.Command {
return
diff --git a/ini.go b/ini.go
index 3c4cbb4..ce95d13 100644
--- a/ini.go
+++ b/ini.go
@@ -69,7 +69,7 @@
}
// ParseFile parses flags from an ini formatted file. See Parse for more
-// information on the ini file foramt. The returned errors can be of the type
+// information on the ini file format. The returned errors can be of the type
// flags.Error or flags.IniError.
func (i *IniParser) ParseFile(filename string) error {
i.parser.storeDefaults()
diff --git a/man.go b/man.go
index 93d6149..89fdc7c 100644
--- a/man.go
+++ b/man.go
@@ -60,7 +60,7 @@
})
}
-func writeManPageSubCommands(wr io.Writer, name string, root *Command) {
+func writeManPageSubcommands(wr io.Writer, name string, root *Command) {
commands := root.sortedCommands()
for _, c := range commands {
@@ -97,7 +97,7 @@
}
writeManPageOptions(wr, command.Group)
- writeManPageSubCommands(wr, name, command)
+ writeManPageSubcommands(wr, name, command)
}
// WriteManPage writes a basic man page in groff format to the specified
@@ -129,6 +129,6 @@
if len(p.commands) > 0 {
fmt.Fprintln(wr, ".SH COMMANDS")
- writeManPageSubCommands(wr, "", p.Command)
+ writeManPageSubcommands(wr, "", p.Command)
}
}
diff --git a/option.go b/option.go
index 150a94f..f4041d6 100644
--- a/option.go
+++ b/option.go
@@ -11,7 +11,7 @@
// flag is optional.
type Option struct {
// The description of the option flag. This description is shown
- // automatically in the builtin help.
+ // automatically in the built-in help.
Description string
// The short name of the option (a single character). If not 0, the
diff --git a/parser.go b/parser.go
index f542393..504cf56 100644
--- a/parser.go
+++ b/parser.go
@@ -97,7 +97,7 @@
}
// NewNamedParser creates a new parser. The appname is used to display the
-// executable name in the builtin help message. Option groups and commands can
+// executable name in the built-in help message. Option groups and commands can
// be added to this parser by using AddGroup and AddCommand.
func NewNamedParser(appname string, options Options) *Parser {
return &Parser{
@@ -133,7 +133,7 @@
})
}, true)
- // Add builtin help group to all commands if necessary
+ // Add built-in help group to all commands if necessary
if (p.Options & HelpFlag) != None {
p.addHelpGroups(p.showBuiltinHelp)
}
