Merge pull request kubernetes-sigs#325 from vincepri/indexer-func-doc

k8s-ci-robot · web-flow · commit d25df1b79d16 · 2019-02-14T10:59:53.000-08:00
:docs: Clarify IndexerFunc comment with namespaced objects
diff --git a/pkg/client/interfaces.go b/pkg/client/interfaces.go
@@ -89,7 +89,8 @@ type Client interface {
 }
 
 // IndexerFunc knows how to take an object and turn it into a series
-// of (non-namespaced) keys for that object.
+// of non-namespaced keys. Namespaced objects are automatically given
+// namespaced and non-spaced variants, so keys do not need to include namespace.
 type IndexerFunc func(runtime.Object) []string
 
 // FieldIndexer knows how to index over a particular "field" such that it

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,8 @@ type Client interface {`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`// IndexerFunc knows how to take an object and turn it into a series`
`92`		`-// of (non-namespaced) keys for that object.`
	`92`	`+// of non-namespaced keys. Namespaced objects are automatically given`
	`93`	`+// namespaced and non-spaced variants, so keys do not need to include namespace.`
`93`	`94`	`type IndexerFunc func(runtime.Object) []string`
`94`	`95`
`95`	`96`	`// FieldIndexer knows how to index over a particular "field" such that it`