From fde4604efce3c6c2b471b5a494cddcdf124867b0 Mon Sep 17 00:00:00 2001 From: irfan sharif Date: Thu, 28 Oct 2021 16:12:44 -0400 Subject: [PATCH] rangefeed: improve a comment Release note: None --- pkg/kv/kvclient/rangefeed/rangefeed.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pkg/kv/kvclient/rangefeed/rangefeed.go b/pkg/kv/kvclient/rangefeed/rangefeed.go index f2b728d5e7eb..0ef98e9281ef 100644 --- a/pkg/kv/kvclient/rangefeed/rangefeed.go +++ b/pkg/kv/kvclient/rangefeed/rangefeed.go @@ -193,8 +193,9 @@ func (f *RangeFeed) Start(ctx context.Context) error { return nil } -// Close closes the RangeFeed and waits for it to shut down. -// Close is idempotent. +// Close closes the RangeFeed and waits for it to shut down; it does +// idempotently. It's guaranteed that no future handlers will be invoked after +// this point. func (f *RangeFeed) Close() { f.closeOnce.Do(func() { f.cancel()