From: David Symonds <dsymonds@golang.org>
Date: Thu, 19 May 2011 04:53:26 +0000 (+1000)
Subject: flag: fix docs on flag.Var.
X-Git-Tag: weekly.2011-05-22~22
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=bddd092dc37e562f23e3599096de6ac5708fdf1b;p=gostls13.git

flag: fix docs on flag.Var.

R=golang-dev, r
CC=golang-dev
https://golang.org/cl/4539067
---

diff --git a/src/pkg/flag/flag.go b/src/pkg/flag/flag.go
index 9ed20e06b5..062d4a52f0 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()}