clientv3: document context to "Snapshot" API

Signed-off-by: Gyuho Lee <[email protected]>
etcd-io · Dec 18, 2017 · 677301d · 677301d
1 parent ac2ab6b
commit 677301d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/clientv3/maintenance.go b/clientv3/maintenance.go
@@ -55,6 +55,8 @@ type Maintenance interface {
 	HashKV(ctx context.Context, endpoint string, rev int64) (*HashKVResponse, error)
 
 	// Snapshot provides a reader for a point-in-time snapshot of etcd.
+	// If the context "ctx" is canceled or timed out, reading from returned
+	// "io.ReadCloser" would error out (e.g. context.Canceled, context.DeadlineExceeded).
 	Snapshot(ctx context.Context) (io.ReadCloser, error)
 
 	// MoveLeader requests current leader to transfer its leadership to the transferee.