Update ModifyIndex comment

8 years ago · 12e46503f7
parent b3c280772f
commit 12e46503f7
1 changed files with 3 additions and 1 deletions
--- a/api/kv.go
+++ b/api/kv.go
@ -19,7 +19,9 @@ type KVPair struct {
 	// is a read-only field.
 	CreateIndex uint64

-	// ModifyIndex is used for the Check-And-Set operations.
+	// ModifyIndex is used for the Check-And-Set operations and can also be fed
+	// back into the WaitIndex of the QueryOptions in order to perform blocking
+	// queries.
 	ModifyIndex uint64

 	// LockIndex holds the index corresponding to a lock on this key, if any. This