Browse Source

storage: refine Watch comment in WatchableKV

Explain explicitly how these arguments are used.
Yicheng Qin 10 years ago
parent
commit
027c073d55
1 changed files with 3 additions and 2 deletions
  1. 3 2
      storage/kv.go

+ 3 - 2
storage/kv.go

@@ -93,8 +93,9 @@ type Watcher interface {
 type WatchableKV interface {
 type WatchableKV interface {
 	KV
 	KV
 
 
-	// Watcher watches the events happening or happened in etcd. The whole
-	// event history can be watched unless compacted.
+	// Watcher watches the events happening or happened on the given key
+	// or key prefix from the given startRev.
+	// The whole event history can be watched unless compacted.
 	// If `prefix` is true, watch observes all events whose key prefix could be the given `key`.
 	// If `prefix` is true, watch observes all events whose key prefix could be the given `key`.
 	// If `startRev` <=0, watch observes events after currentRev.
 	// If `startRev` <=0, watch observes events after currentRev.
 	//
 	//