From bddd092dc37e562f23e3599096de6ac5708fdf1b Mon Sep 17 00:00:00 2001 From: David Symonds Date: Thu, 19 May 2011 14:53:26 +1000 Subject: [PATCH] flag: fix docs on flag.Var. R=golang-dev, r CC=golang-dev https://golang.org/cl/4539067 --- src/pkg/flag/flag.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/pkg/flag/flag.go b/src/pkg/flag/flag.go index 9ed20e06b5a..062d4a52f0e 100644 --- a/src/pkg/flag/flag.go +++ b/src/pkg/flag/flag.go @@ -405,8 +405,12 @@ func Float64(name string, value float64, usage string) *float64 { return p } -// Var defines a user-typed flag with specified name, default value, and usage string. -// The argument p points to a Value variable in which to store the value of the flag. +// Var defines a flag with the specified name and usage string. The type and +// value of the flag are represented by the first argument, of type Value, which +// typically holds a user-defined implementation of Value. For instance, the +// caller could create a flag that turns a comma-separated string into a slice +// of strings by giving the slice the methods of Value; in particular, Set would +// decompose the comma-separated string into the slice. func Var(value Value, name string, usage string) { // Remember the default value as a string; it won't change. f := &Flag{name, usage, value, value.String()}