From dd3856e1b0d9250f4625108b9979d09ab48175e4 Mon Sep 17 00:00:00 2001 From: David Symonds Date: Sat, 28 Jun 2014 20:47:06 +1000 Subject: [PATCH] flag: add a little more doc comment to Duration. The only text that describes the accepted format is in the package doc, which is far away from these functions. The other flag types don't need this explicitness because they are more obvious. LGTM=r R=r CC=golang-codereviews https://golang.org/cl/101550043 --- src/pkg/flag/flag.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/pkg/flag/flag.go b/src/pkg/flag/flag.go index cd2a165be1..5797cc79d4 100644 --- a/src/pkg/flag/flag.go +++ b/src/pkg/flag/flag.go @@ -628,18 +628,21 @@ func Float64(name string, value float64, usage string) *float64 { // DurationVar defines a time.Duration flag with specified name, default value, and usage string. // The argument p points to a time.Duration variable in which to store the value of the flag. +// The flag accepts a value acceptable to time.ParseDuration. func (f *FlagSet) DurationVar(p *time.Duration, name string, value time.Duration, usage string) { f.Var(newDurationValue(value, p), name, usage) } // DurationVar defines a time.Duration flag with specified name, default value, and usage string. // The argument p points to a time.Duration variable in which to store the value of the flag. +// The flag accepts a value acceptable to time.ParseDuration. func DurationVar(p *time.Duration, name string, value time.Duration, usage string) { CommandLine.Var(newDurationValue(value, p), name, usage) } // Duration defines a time.Duration flag with specified name, default value, and usage string. // The return value is the address of a time.Duration variable that stores the value of the flag. +// The flag accepts a value acceptable to time.ParseDuration. func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time.Duration { p := new(time.Duration) f.DurationVar(p, name, value, usage) @@ -648,6 +651,7 @@ func (f *FlagSet) Duration(name string, value time.Duration, usage string) *time // Duration defines a time.Duration flag with specified name, default value, and usage string. // The return value is the address of a time.Duration variable that stores the value of the flag. +// The flag accepts a value acceptable to time.ParseDuration. func Duration(name string, value time.Duration, usage string) *time.Duration { return CommandLine.Duration(name, value, usage) } -- 2.48.1