nomad/watch: add a note about the Item struct

hashicorp · Nov 4, 2015 · 2a1577e · 2a1577e
1 parent 5f53478
commit 2a1577e
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/nomad/watch/watch.go b/nomad/watch/watch.go
@@ -5,7 +5,9 @@ package watch
 // the underlying state store.
 
 // Item describes the scope of a watch. It is used to provide a uniform
-// input for subscribe/unsubscribe and notification firing.
+// input for subscribe/unsubscribe and notification firing. Specifying
+// multiple fields does not place a watch on multiple items. Each Item
+// describes exactly one scoped watch.
 type Item struct {
 	Alloc     string
 	AllocEval string