clientv3: document context to "KeepAlive" API

Signed-off-by: Gyuho Lee <gyuhox@gmail.com>
etcd-io · Dec 15, 2017 · 8c2d75f · 8c2d75f
1 parent 940dace
commit 8c2d75f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/clientv3/lease.go b/clientv3/lease.go
@@ -114,6 +114,9 @@ type Lease interface {
 	Leases(ctx context.Context) (*LeaseLeasesResponse, error)
 
 	// KeepAlive keeps the given lease alive forever.
+	// If the context "ctx" is canceled or timed out,
+	// returned "LeaseKeepAliveResponse" channel is closed,
+	// and "LeaseKeepAliveResponse" from this closed channel is nil.
 	KeepAlive(ctx context.Context, id LeaseID) (<-chan *LeaseKeepAliveResponse, error)
 
 	// KeepAliveOnce renews the lease once. In most of the cases, KeepAlive