Add SliceValue Comments

therealmitchconnors · therealmitchconnors · commit 68f4136ecf4c · 2019-09-10T09:27:08.000-07:00
diff --git a/flag.go b/flag.go
@@ -190,9 +190,15 @@ type Value interface {
 	Type() string
 }
 
+// SliceValue is a secondary interface to all flags which hold a list
+// of values.  This allows full control over the value of list flags,
+// and avoids complicated marshalling and unmarshalling to csv.
 type SliceValue interface {
+	// Append adds the specified value to the end of the flag value list.
 	Append(string) error
+	// Replace will fully overwrite any data currently in the flag value list.
 	Replace([]string) error
+	// GetSlice returns the flag value list as an array of strings.
 	GetSlice() []string
 }
 

Original file line number	Diff line number	Diff line change
`@@ -190,9 +190,15 @@ type Value interface {`
`190`	`190`	`Type() string`
`191`	`191`	`}`
`192`	`192`
	`193`	`+// SliceValue is a secondary interface to all flags which hold a list`
	`194`	`+// of values. This allows full control over the value of list flags,`
	`195`	`+// and avoids complicated marshalling and unmarshalling to csv.`
`193`	`196`	`type SliceValue interface {`
	`197`	`+ // Append adds the specified value to the end of the flag value list.`
`194`	`198`	`Append(string) error`
	`199`	`+ // Replace will fully overwrite any data currently in the flag value list.`
`195`	`200`	`Replace([]string) error`
	`201`	`+ // GetSlice returns the flag value list as an array of strings.`
`196`	`202`	`GetSlice() []string`
`197`	`203`	`}`
`198`	`204`