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

:docs: Clarify IndexerFunc comment with namespaced objects
kubernetes-sigs · Feb 14, 2019 · d25df1b · d25df1b
2 parents 45d6520 + 496f339
commit d25df1b
Showing 1 changed file with 2 additions and 1 deletion.
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